Package de.aristaflow.adept2.base.security.callbackhandler

Class NameOrgPosSesIDAppNameHandler

java.lang.Object

de.aristaflow.adept2.base.security.callbackhandler.NameOrgPosSesIDAppNameHandler

All Implemented Interfaces:

AFCallbackHandler

public class NameOrgPosSesIDAppNameHandler
extends Object
implements AFCallbackHandler

This handler provides the means to handle NameCallback, OrgPositionChoiceCallback, AppNameCallback, and UserSessionIDCallback. All data is provided in the constructor of this handler.

Author:

Ulrich Kreher

Constructor Summary

Constructors

Constructor	Description
NameOrgPosSesIDAppNameHandler(String userName, Collection<QualifiedAgent> agents, String appName, String userSessionID)	Creates a new handler for NameCallback, OrgPositionChoiceCallback and UserSessionIDCallback.
NameOrgPosSesIDAppNameHandler(Collection<QualifiedAgent> agents, String appName, String userSessionID)	Creates a new handler for NameCallback, OrgPositionChoiceCallback and UserSessionIDCallback.

Method Summary

Modifier and Type	Method	Description
Callback[]	handle(Callback[] callbacks)	This method is similar to CallbackHandler.handle(Callback[]) but returns the provided callbacks back to the caller.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NameOrgPosSesIDAppNameHandler

public NameOrgPosSesIDAppNameHandler(String userName,
                                     Collection<QualifiedAgent> agents,
                                     String appName,
                                     String userSessionID)

Creates a new handler for NameCallback, OrgPositionChoiceCallback and UserSessionIDCallback.

Parameters:

userName - The unique name of the user to log on. This must not be null nor an empty/blank string. Note that this name is case-sensitive!

agents - The organisational positions of the agent with the set name which to log on. All these agents need to have the provided userName. These have to contain at least one qualified agent.

appName - The application name for which to log on. This may be null.

userSessionID - The user session ID to use for all provided agents. This may be null.

NameOrgPosSesIDAppNameHandler

public NameOrgPosSesIDAppNameHandler(Collection<QualifiedAgent> agents,
                                     String appName,
                                     String userSessionID)

Creates a new handler for NameCallback, OrgPositionChoiceCallback and UserSessionIDCallback. The user name is taken from the provided collection of agents.

Parameters:

agents - The user name and the organisational positions of the agent with the set name which to log on. All these agents need to have the same user name. These have to contain at least one qualified agent.

appName - The application name for which to log on. This may be null.

userSessionID - The user session ID to use for all provided agents. This may be null.

Method Detail

handle

public Callback[] handle(Callback[] callbacks)
                  throws IOException,
                         UnsupportedCallbackException

Description copied from interface: AFCallbackHandler

This method is similar to CallbackHandler.handle(Callback[]) but returns the provided callbacks back to the caller. This allows for calling this method remotely. Note that all callbacks need to be serialisable.
When called remotely, the provided callbacks are copies of the server-side objects. When changing these objects, the changes are not reflected on server side. Therefore these objects (or rather copies of them) need to be returned.

Specified by:

handle in interface AFCallbackHandler

Parameters:

callbacks - The callbacks to be handled by this callback handler.

Returns:

All the callbacks that should be handled by this callback handler. Just return the complete array of callbacks. Do not skip any callbacks, for instance the ones that the callback handler did not handle!

Throws:

IOException - If an input or output error occurs, an IOException will be thrown.

UnsupportedCallbackException - If the implementation of this method does not support one or more of the callbacks specified in the callbacks parameter, an UnsupportedCallbackException will be thrown.