Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

com.tarantella.tta.webservices.vsbim
Class SGDBroker

java.lang.Object
  extended by com.tarantella.tta.webservices.vsbim.SGDBroker
All Implemented Interfaces:
IVirtualServerBroker
Direct Known Subclasses:
UserDefinedSGDBroker

public class SGDBroker
extends java.lang.Object
implements IVirtualServerBroker

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.

Since:
1.3

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, APP_SERVER_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

MAPPING

public static final java.lang.String MAPPING
Key for the dynamic application mapping.

See Also:
Constant Field Values

SESSION_COOKIE

public static final java.lang.String SESSION_COOKIE
Key for the session cookie of the SGD user

See Also:
Constant Field Values
Constructor Detail

SGDBroker

public SGDBroker()
Constructor.

Since:
1.3
Method Detail

setServiceLocator

public void setServiceLocator(IServiceLocator serviceLocator)
Sets the service locator for the SGD web services.

Parameters:
serviceLocator - The service locator to use.
Since:
1.3

getServiceLocator

public IServiceLocator getServiceLocator()
Gets the service locator for the SGD web services.

Returns:
The service locator.
Since:
1.3

initialise

public void initialise(java.util.Map<java.lang.String,java.lang.String> initialisationParameters)
                throws VirtualServerBrokerException
This broker uses no parameters.

Specified by:
initialise in interface IVirtualServerBroker
Parameters:
initialisationParameters - The parameters to use when initialising the broker.
Throws:
VirtualServerBrokerException - if there was a problem during initialisation.
Since:
1.3

getCandidateServers

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
Return a Map of candidate servers for a launch.

Mandatory parameters:

The mapping is from the broker specified type, see ICandidateServer.getType() to a list ILaunchCandidates that support that type of application.

Specified by:
getCandidateServers in interface IVirtualServerBroker
Parameters:
parameters - Parameters used to pick candidate application servers.
Returns:
A map of candidate servers. It is never null.
Throws:
VirtualServerBrokerAuthException - If there was a problem authenticating with the SGD server.
VirtualServerBrokerException - if there was a problem getting launch candidates.
Since:
1.3

prepareCandidate

public ICandidateServer prepareCandidate(java.lang.String type,
                                         ICandidateServer candidateToPrepare)
                                  throws VirtualServerBrokerException
Description copied from interface: IVirtualServerBroker
Prepares the given candidate so that it can be used to launch applications. This method is intended to be called once a candidate has been chosen from the list returned by 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.

Specified by:
prepareCandidate in interface IVirtualServerBroker
Parameters:
type - The type of candidate to prepare.
candidateToPrepare - The server that is to be prepared for use.
Returns:
An ICandidateServer that represents the details of the server that should be used for launching the application or desktop.
Throws:
VirtualServerBrokerException - if there was a problem during preparation.
See Also:
IVirtualServerBroker.getCandidateServers(java.util.Map)

isAuthenticationRequired

public boolean isAuthenticationRequired()
Description copied from interface: IVirtualServerBroker
Returns a flag indicating whether the broker requires authentication or not.

Specified by:
isAuthenticationRequired in interface IVirtualServerBroker
Returns:
false

destroy

public void destroy()
Description copied from interface: IVirtualServerBroker
Disposes of this broker. This method is intended to close connections, clear cached state, et cetera. It should be called when the broker instance is no longer required, allowing it to free any resources it holds.

Specified by:
destroy in interface IVirtualServerBroker

getScope

public IVirtualServerBroker.Scope getScope()
Get the scope of this broker. SGD brokers should be kept for the lifetime of the application.

Specified by:
getScope in interface IVirtualServerBroker
Returns:
IVirtualServerBroker.Scope.APPLICATION

Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

Copyright © 2012, 2013, Oracle and/or its affiliates. All rights reserved.