amwebarsentitlementservice.client
Class FixedProviderClient

java.lang.Object
  |
  +--amwebarsentitlementservice.client.FixedProviderClient
All Implemented Interfaces:
AMWebARSClient, java.lang.Cloneable, PoolElement

public class FixedProviderClient
extends java.lang.Object
implements AMWebARSClient


Field Summary
protected static ClientInitStatus CLIENT_INIT_SUCCESS
           
protected static ClientRunStatus CLIENT_RUN_SUCCESS
           
protected static ClientShutdownStatus CLIENT_SHUTDOWN_SUCCESS
           
 
Constructor Summary
FixedProviderClient()
          Constructor for FixedProviderClient.
FixedProviderClient(AMWebARSProtocol protocol, AMWebARSProvider provider)
          Constructor for FixedProviderClient.
 
Method Summary
 void addContainer(AMWebARSContainer container)
          Adds a AMWebARSContainer to the client.
 void addContainerDescriptor(AMWebARSContainerDescriptor descriptor)
          Adds a container descriptor to the client.
 void clear()
          Removed all AMWebARSContainerDescriptors from the client.
 void clearInternalState()
           
 java.lang.Object clone()
           
 boolean containsContainerDescriptor(AMWebARSContainerDescriptor descriptor)
          Tests the client contains a certain descriptor.
 java.util.Iterator elements()
          Returns an Enumeration of the AMWebARSContainerDescriptors, stored in the client.
 boolean equals(java.lang.Object other_object)
          Tests whether this client is equal to another.
 AMWebARSClientMemento generateMemento()
          Generates a new AMWebARSClientMemento which represents the clients current state.
 java.util.Map getAppContext()
          Returns the app_context.
 int getPoolIndex()
           
 AMWebARSProtocol getProtocol()
          Gets the protocol.
 AMWebARSProvider getProvider()
          Gets the provider.
 java.net.URL getRequestedURL()
          Gets the requestedURL.
 Session getSession()
          Gets the session.
 Subject getSubject()
          Gets the subject.
 ClientInitStatus init()
          Inits the client and the corresponding protocol.
 boolean isEmpty()
          Tests whether this client contains no AMWebARSContainerDescriptors.
 java.util.Iterator keys()
          Returns an Enumeration of the container_type_ids, stored in the client.
 AMWebARSContainerDescriptor removeContainerDescriptor(AMWebARSContainerDescriptor descriptor)
          Removes a container descriptor from the client.
 ClientRunStatus run()
          Runs the client.
 void setMemento(AMWebARSClientMemento memento)
          Resets the client to the state that is saved in the given memento.
 void setPoolIndex(int index)
           
 void setProtocol(AMWebARSProtocol protocol)
          Sets the protocol.
 void setProvider(AMWebARSProvider provider)
          Sets the provider.
 void setRequestedURL(java.net.URL requested_url)
          Sets the requestedURL.
 void setSession(Session session)
          Sets the session.
 void setSubject(Subject subject)
          Sets the subject.
 ClientShutdownStatus shutdown()
          Shuts the client down.
 int size()
          Detirmined the number of AMWebARSContainerDescriptors this client contains.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLIENT_INIT_SUCCESS

protected static final ClientInitStatus CLIENT_INIT_SUCCESS

CLIENT_RUN_SUCCESS

protected static final ClientRunStatus CLIENT_RUN_SUCCESS

CLIENT_SHUTDOWN_SUCCESS

protected static final ClientShutdownStatus CLIENT_SHUTDOWN_SUCCESS
Constructor Detail

FixedProviderClient

public FixedProviderClient()
Constructor for FixedProviderClient.

FixedProviderClient

public FixedProviderClient(AMWebARSProtocol protocol,
                           AMWebARSProvider provider)
Constructor for FixedProviderClient.
Method Detail

clone

public java.lang.Object clone()
Specified by:
clone in interface PoolElement
Overrides:
clone in class java.lang.Object

generateMemento

public AMWebARSClientMemento generateMemento()
Description copied from interface: AMWebARSClient
Generates a new AMWebARSClientMemento which represents the clients current state.
Specified by:
generateMemento in interface AMWebARSClient
See Also:
AMWebARSClient.generateMemento()

setMemento

public void setMemento(AMWebARSClientMemento memento)
Description copied from interface: AMWebARSClient
Resets the client to the state that is saved in the given memento.
Specified by:
setMemento in interface AMWebARSClient
See Also:
AMWebARSClient.setMemento(AMWebARSClientMemento)

getSubject

public Subject getSubject()
Description copied from interface: AMWebARSClient
Gets the subject.
Specified by:
getSubject in interface AMWebARSClient
See Also:
AMWebARSClient.getSubject()

setSubject

public void setSubject(Subject subject)
Description copied from interface: AMWebARSClient
Sets the subject.
Specified by:
setSubject in interface AMWebARSClient
See Also:
AMWebARSClient.setSubject(Subject)

getRequestedURL

public java.net.URL getRequestedURL()
Description copied from interface: AMWebARSClient
Gets the requestedURL.
Specified by:
getRequestedURL in interface AMWebARSClient
See Also:
AMWebARSClient.getRequestedURL()

setRequestedURL

public void setRequestedURL(java.net.URL requested_url)
Description copied from interface: AMWebARSClient
Sets the requestedURL.
Specified by:
setRequestedURL in interface AMWebARSClient
See Also:
AMWebARSClient.setRequestedURL(URL)

getProvider

public AMWebARSProvider getProvider()
Description copied from interface: AMWebARSClient
Gets the provider.
Specified by:
getProvider in interface AMWebARSClient
See Also:
AMWebARSClient.getProvider()

setProvider

public void setProvider(AMWebARSProvider provider)
Description copied from interface: AMWebARSClient
Sets the provider.
Specified by:
setProvider in interface AMWebARSClient
See Also:
AMWebARSClient.setProvider(AMWebARSProvider)

getProtocol

public AMWebARSProtocol getProtocol()
Description copied from interface: AMWebARSClient
Gets the protocol.
Specified by:
getProtocol in interface AMWebARSClient
See Also:
AMWebARSClient.getProtocol()

setProtocol

public void setProtocol(AMWebARSProtocol protocol)
Description copied from interface: AMWebARSClient
Sets the protocol.
Specified by:
setProtocol in interface AMWebARSClient
See Also:
AMWebARSClient.setProtocol(AMWebARSProtocol)

getAppContext

public java.util.Map getAppContext()
Returns the app_context.
Specified by:
getAppContext in interface AMWebARSClient
Returns:
Map

addContainerDescriptor

public void addContainerDescriptor(AMWebARSContainerDescriptor descriptor)
                            throws java.lang.UnsupportedOperationException
Adds a container descriptor to the client. The container descriptor has to match the clients combination of protocol_id and provider_id. Otherwise the method throws an exception.
Specified by:
addContainerDescriptor in interface AMWebARSClient
Parameters:
descriptor - ContainerDescriptor, which shall be retrieved by this client.
Throws:
java.lang.UnsupportedOperationException - if the protocol_id or provider_id doesn't match.
NullPointerException - if the descriptor is null.
See Also:
AMWebARSClient.addContainerDescriptor(AMWebARSContainerDescriptor)

removeContainerDescriptor

public AMWebARSContainerDescriptor removeContainerDescriptor(AMWebARSContainerDescriptor descriptor)
                                                      throws java.util.NoSuchElementException
Removes a container descriptor from the client.
Specified by:
removeContainerDescriptor in interface AMWebARSClient
Parameters:
descriptor - AMWebARScontainerDescriptor to be removed
Returns:
removed descriptor
Throws:
NullPointerException - if the descriptor is null
java.util.NoSuchElementException - if the descriptor isn't contained in the client
See Also:
AMWebARSClient.removeContainerDescriptor(AMWebARSContainerDescriptor)

containsContainerDescriptor

public boolean containsContainerDescriptor(AMWebARSContainerDescriptor descriptor)
Tests the client contains a certain descriptor.
Specified by:
containsContainerDescriptor in interface AMWebARSClient
Parameters:
descriptor - AMWebARScontainerDescriptor to looked for.
Returns:
true is the client contains the descriptor
Throws:
NullPointerException - if the descriptor is null
java.lang.UnsupportedOperationException - if the protocol_id or provider_id doesn't match.
See Also:
AMWebARSClient.containsContainerDescriptor(AMWebARSContainerDescriptor)

size

public int size()
Detirmined the number of AMWebARSContainerDescriptors this client contains.
Specified by:
size in interface AMWebARSClient
Returns:
number of descriptors
See Also:
AMWebARSClient.size()

isEmpty

public boolean isEmpty()
Tests whether this client contains no AMWebARSContainerDescriptors.
Specified by:
isEmpty in interface AMWebARSClient
Returns:
true if the client contains no container descriptors
See Also:
AMWebARSClient.isEmpty()

clear

public void clear()
Removed all AMWebARSContainerDescriptors from the client.
Specified by:
clear in interface AMWebARSClient
See Also:
AMWebARSClient.clear()

elements

public java.util.Iterator elements()
Returns an Enumeration of the AMWebARSContainerDescriptors, stored in the client.
Specified by:
elements in interface AMWebARSClient
Returns:
Enumeration of descriptors
See Also:
AMWebARSClient.elements()

keys

public java.util.Iterator keys()
Returns an Enumeration of the container_type_ids, stored in the client. We use
Specified by:
keys in interface AMWebARSClient
Returns:
Enumeration of container_type_ids
See Also:
AMWebARSClient.keys()

addContainer

public void addContainer(AMWebARSContainer container)
Description copied from interface: AMWebARSClient
Adds a AMWebARSContainer to the client.
Specified by:
addContainer in interface AMWebARSClient
Following copied from interface: amwebarsentitlementservice.client.AMWebARSClient
Parameters:
container - to be added

getSession

public Session getSession()
Description copied from interface: AMWebARSClient
Gets the session.
Specified by:
getSession in interface AMWebARSClient
See Also:
AMWebARSClient.getSession()

setSession

public void setSession(Session session)
Description copied from interface: AMWebARSClient
Sets the session.
Specified by:
setSession in interface AMWebARSClient
See Also:
AMWebARSClient.setSession(Session)

init

public ClientInitStatus init()
Description copied from interface: AMWebARSClient
Inits the client and the corresponding protocol.
Specified by:
init in interface AMWebARSClient
See Also:
AMWebARSClient.init()

run

public ClientRunStatus run()
Description copied from interface: AMWebARSClient
Runs the client.
Specified by:
run in interface AMWebARSClient
See Also:
AMWebARSClient.run()

shutdown

public ClientShutdownStatus shutdown()
Description copied from interface: AMWebARSClient
Shuts the client down.
Specified by:
shutdown in interface AMWebARSClient
See Also:
AMWebARSClient.shutdown()

clearInternalState

public void clearInternalState()
Specified by:
clearInternalState in interface PoolElement

setPoolIndex

public void setPoolIndex(int index)
Specified by:
setPoolIndex in interface PoolElement

getPoolIndex

public int getPoolIndex()
Specified by:
getPoolIndex in interface PoolElement

equals

public boolean equals(java.lang.Object other_object)
Tests whether this client is equal to another.
Overrides:
equals in class java.lang.Object
Returns:
boolean true if both obj are the same.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object