Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

com.tarantella.tta.webservices.vsbim
Class UserDefinedSGDBroker

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

public class UserDefinedSGDBroker
extends SGDBroker

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.

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

CREATE_APPSERVER

public static final java.lang.String CREATE_APPSERVER
See Also:
Constant Field Values

HIDE_APPSERVERS

public static final java.lang.String HIDE_APPSERVERS
See Also:
Constant Field Values

CHECK_APPSERVER

public static final java.lang.String CHECK_APPSERVER
See Also:
Constant Field Values
Constructor Detail

UserDefinedSGDBroker

public UserDefinedSGDBroker()
Method Detail

initialise

public void initialise(java.util.Map<java.lang.String,java.lang.String> initialisationParameters)
                throws VirtualServerBrokerException
Initialise using the given parameters.

Optional Parameters:
Key IVirtualServerBroker.PARAMS This string can contain the following flags:

Specified by:
initialise in interface IVirtualServerBroker
Overrides:
initialise in class SGDBroker
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
Description copied from class: SGDBroker
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
Overrides:
getCandidateServers in class SGDBroker
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.

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
Overrides:
prepareCandidate in class SGDBroker
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)

getScope

public IVirtualServerBroker.Scope getScope()
Description copied from class: SGDBroker
Get the scope of this broker. SGD brokers should be kept for the lifetime of the application.

Specified by:
getScope in interface IVirtualServerBroker
Overrides:
getScope in class SGDBroker
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.