|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A AMWebARSClient manages all the communciation with dynADI providers. We use an interface as superclass, because this allows mix-ins of other classes.
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. |
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. |
AMWebARSClientMemento |
generateMemento()
Generates a new AMWebARSClientMemento which represents the clients current state. |
java.util.Map |
getAppContext()
Gets the app_context. |
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 |
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. |
Methods inherited from interface amwebarsentitlementservice.elementpool.PoolElement |
clearInternalState, clone, getPoolIndex, setPoolIndex |
Method Detail |
public AMWebARSClientMemento generateMemento()
public void setMemento(AMWebARSClientMemento memento)
public Subject getSubject()
public void setSubject(Subject subject)
subject
- The subject to setpublic java.util.Map getAppContext()
public java.net.URL getRequestedURL()
public void setRequestedURL(java.net.URL requested_url)
requestedURL
- The requestedURL to setpublic AMWebARSProvider getProvider()
public void setProvider(AMWebARSProvider provider)
provider
- The provider to setpublic AMWebARSProtocol getProtocol()
public void setProtocol(AMWebARSProtocol protocol)
protocol
- The protocol to setpublic void addContainerDescriptor(AMWebARSContainerDescriptor descriptor) throws java.lang.UnsupportedOperationException
descriptor
- ContainerDescriptor, which shall be retrieved by this client.java.lang.UnsupportedOperationException
- if the protocol_id or provider_id
doesn't match.NullPointerException
- if the descriptor is null.public AMWebARSContainerDescriptor removeContainerDescriptor(AMWebARSContainerDescriptor descriptor) throws java.util.NoSuchElementException
descriptor
- AMWebARScontainerDescriptor to be removedNullPointerException
- if the descriptor is nulljava.util.NoSuchElementException
- if the descriptor isn't contained in the clientpublic boolean containsContainerDescriptor(AMWebARSContainerDescriptor descriptor)
descriptor
- AMWebARScontainerDescriptor to looked for.NullPointerException
- if the descriptor is nullpublic int size()
public boolean isEmpty()
public void clear()
public java.util.Iterator elements()
public java.util.Iterator keys()
public void addContainer(AMWebARSContainer container)
container
- to be addedpublic Session getSession()
public void setSession(Session session)
session
- The session to setpublic ClientInitStatus init()
public ClientRunStatus run()
public ClientShutdownStatus shutdown()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |