|
Oracle Secure Global Desktop Web Services API Documentation Release 4.7 E21396-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tarantella.tta.webservices.vsbim.SGDBroker
com.tarantella.tta.webservices.vsbim.UserDefinedSGDBroker
public class UserDefinedSGDBroker
This class extends SGDBroker
.
It gets its list of servers in the same way as that class, but also adds a
candidate that allows a user to define the details of the server on which the
application is launched.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.tarantella.tta.webservices.vsbim.IVirtualServerBroker |
---|
IVirtualServerBroker.Scope |
Field Summary | |
---|---|
static java.lang.String |
CHECK_APPSERVER
|
static java.lang.String |
CREATE_APPSERVER
|
static java.lang.String |
HIDE_APPSERVERS
|
Fields inherited from class com.tarantella.tta.webservices.vsbim.SGDBroker |
---|
MAPPING, SESSION_COOKIE |
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 | |
---|---|
UserDefinedSGDBroker()
|
Method Summary | |
---|---|
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. |
void |
initialise(java.util.Map<java.lang.String,java.lang.String> initialisationParameters)
Initialise using the given parameters. |
ICandidateServer |
prepareCandidate(java.lang.String type,
ICandidateServer candidateToPrepare)
Prepares the given candidate so that it can be used to launch applications. |
Methods inherited from class com.tarantella.tta.webservices.vsbim.SGDBroker |
---|
destroy, getServiceLocator, isAuthenticationRequired, setServiceLocator |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CREATE_APPSERVER
public static final java.lang.String HIDE_APPSERVERS
public static final java.lang.String CHECK_APPSERVER
Constructor Detail |
---|
public UserDefinedSGDBroker()
Method Detail |
---|
public void initialise(java.util.Map<java.lang.String,java.lang.String> initialisationParameters) throws VirtualServerBrokerException
Optional Parameters:
Key IVirtualServerBroker.PARAMS
This string can contain the following flags:
CREATE_APPSERVER
- A boolean flag that controls whether a user-defined
server created by this broker should have its permanent
flag set. If true
, SGD creates an application server
object in the datastore for this server if one does not already exist.
CHECK_APPSERVER
- A boolean flag. If true
, for user-specified
application servers, SGD checks that the application server has been assigned to
the application object. If the application server is not assigned to the
application object, an error message is shown.
HIDE_APPSERVERS
- A boolean flag. If true
, the list of
application servers is not displayed in the chooser page.
initialise
in interface IVirtualServerBroker
initialise
in class SGDBroker
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
SGDBroker
Map
of candidate servers for a launch.
Mandatory parameters:
SGDBroker.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
getCandidateServers
in class SGDBroker
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
prepareCandidate
in class SGDBroker
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 IVirtualServerBroker.Scope getScope()
SGDBroker
getScope
in interface IVirtualServerBroker
getScope
in class SGDBroker
IVirtualServerBroker.Scope.APPLICATION
|
Oracle Secure Global Desktop Web Services API Documentation Release 4.7 E21396-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |