|
Oracle Secure Global Desktop Web Services API Documentation Release 4.6 E23734-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tarantella.tta.webservices.vsbim.SGDBroker
public class SGDBroker
This class implements IVirtualServerBroker
,
getting its list of servers from Secure Global Desktop. It returns a list
of all the application servers assigned to an application for a given user.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.tarantella.tta.webservices.vsbim.IVirtualServerBroker |
---|
IVirtualServerBroker.Scope |
Field Summary | |
---|---|
static java.lang.String |
MAPPING
Key for the dynamic application mapping. |
static java.lang.String |
SESSION_COOKIE
Key for the session cookie of the SGD user |
Fields inherited from interface com.tarantella.tta.webservices.vsbim.IVirtualServerBroker |
---|
APP_NAME, CONNECTION_PROTOCOL, DEFAULT_TYPE, DOMAIN, NO_OVERRIDES_FAILOVER, PARAMS, SGD_IDENTITY, SGD_IDENTITY_PREFIX_AD, SGD_IDENTITY_PREFIX_ANON, SGD_IDENTITY_PREFIX_ENS, SGD_IDENTITY_PREFIX_NTAUTH, SGD_IDENTITY_PREFIX_SECURID, SGD_IDENTITY_PREFIX_THIRDPARTY, SGD_IDENTITY_PREFIX_USER, SGD_IDENTITY_PREFIXES, VSB_DOMAIN, VSB_PASSWORD, VSB_USERNAME |
Constructor Summary | |
---|---|
SGDBroker()
Constructor. |
Method Summary | |
---|---|
void |
destroy()
Disposes of this broker. |
java.util.Map<java.lang.String,java.util.List<ICandidateServer>> |
getCandidateServers(java.util.Map<java.lang.String,java.lang.String> parameters)
Return a Map of candidate servers for a launch. |
IVirtualServerBroker.Scope |
getScope()
Get the scope of this broker. |
IServiceLocator |
getServiceLocator()
Gets the service locator for the SGD web services. |
void |
initialise(java.util.Map<java.lang.String,java.lang.String> initialisationParameters)
This broker uses no parameters. |
boolean |
isAuthenticationRequired()
Returns a flag indicating whether the broker requires authentication or not. |
ICandidateServer |
prepareCandidate(java.lang.String type,
ICandidateServer candidateToPrepare)
Prepares the given candidate so that it can be used to launch applications. |
void |
setServiceLocator(IServiceLocator serviceLocator)
Sets the service locator for the SGD web services. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String MAPPING
public static final java.lang.String SESSION_COOKIE
Constructor Detail |
---|
public SGDBroker()
Method Detail |
---|
public void setServiceLocator(IServiceLocator serviceLocator)
serviceLocator
- The service locator to use.public IServiceLocator getServiceLocator()
public void initialise(java.util.Map<java.lang.String,java.lang.String> initialisationParameters) throws VirtualServerBrokerException
initialise
in interface IVirtualServerBroker
initialisationParameters
- The parameters to use when initialising
the broker.
VirtualServerBrokerException
- if there was a problem during
initialisation.public java.util.Map<java.lang.String,java.util.List<ICandidateServer>> getCandidateServers(java.util.Map<java.lang.String,java.lang.String> parameters) throws VirtualServerBrokerAuthException, VirtualServerBrokerException
Map
of candidate servers for a launch.
Mandatory parameters:
SESSION_COOKIE
: session cookie for the user launching the applicationIVirtualServerBroker.APP_NAME
: the application name.
The mapping is from the broker specified type,
see ICandidateServer.getType()
to a list ILaunchCandidates that support that type of application.
getCandidateServers
in interface IVirtualServerBroker
parameters
- Parameters used to pick candidate application servers.
VirtualServerBrokerAuthException
- If there was a problem
authenticating with the SGD server.
VirtualServerBrokerException
- if there was a problem getting launch
candidates.public ICandidateServer prepareCandidate(java.lang.String type, ICandidateServer candidateToPrepare) throws VirtualServerBrokerException
IVirtualServerBroker
getCandidateServers
. Note that,
depending on how a broker prepares the candidate, the candidate returned
may be entirely different to the one supplied to the method. The returned
candidate should always be used in subsequent operations.
prepareCandidate
in interface IVirtualServerBroker
type
- The type of candidate to prepare.candidateToPrepare
- The server that is to be prepared for use.
VirtualServerBrokerException
- if there was a problem during
preparation.IVirtualServerBroker.getCandidateServers(java.util.Map)
public boolean isAuthenticationRequired()
IVirtualServerBroker
isAuthenticationRequired
in interface IVirtualServerBroker
public void destroy()
IVirtualServerBroker
destroy
in interface IVirtualServerBroker
public IVirtualServerBroker.Scope getScope()
getScope
in interface IVirtualServerBroker
IVirtualServerBroker.Scope.APPLICATION
|
Oracle Secure Global Desktop Web Services API Documentation Release 4.6 E23734-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |