|
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 |
public interface IVirtualServerBroker
This interface represents a broker that provides a list of candidate application servers on which an application or desktop may be launched.
Parameters are passed into brokers through Map
objects. Many of
the constants in this class define the keys used in the map.
Nested Class Summary | |
---|---|
static class |
IVirtualServerBroker.Scope
The Scope of a broker - defines how long the broker should be kept for. |
Field Summary | |
---|---|
static java.lang.String |
APP_NAME
Key for the name of the application to be launched |
static java.lang.String |
CONNECTION_PROTOCOL
Key for the protocol to be used to connect to the server |
static java.lang.String |
DEFAULT_TYPE
The default type used for a CandidateServer if it has none/type means nothing in your broker's context. |
static java.lang.String |
DOMAIN
Key for the domain to which the server belongs |
static java.lang.String |
NO_OVERRIDES_FAILOVER
The attribute determines what to do when an application that requires runtime overrides is launched without them. |
static java.lang.String |
PARAMS
The broker's configuration parameters. |
static java.lang.String |
SGD_IDENTITY
Key for the SGD User identity. |
static java.lang.String |
SGD_IDENTITY_PREFIX_AD
SGD prefix for users mapped to the LDAP/Active Directory profile |
static java.lang.String |
SGD_IDENTITY_PREFIX_ANON
SGD prefix for users mapped to the anonymous profile |
static java.lang.String |
SGD_IDENTITY_PREFIX_ENS
SGD prefix for users mapped to persons in the SGD datastore |
static java.lang.String |
SGD_IDENTITY_PREFIX_NTAUTH
SGD prefix for users mapped to the NT profile |
static java.lang.String |
SGD_IDENTITY_PREFIX_SECURID
SGD prefix for users mapped to the SecurID profile |
static java.lang.String |
SGD_IDENTITY_PREFIX_THIRDPARTY
SGD prefix for users mapped to the third-party profile |
static java.lang.String |
SGD_IDENTITY_PREFIX_USER
SGD prefix for users mapped to the Unix profile |
static java.lang.String[] |
SGD_IDENTITY_PREFIXES
Array of SGD prefixes |
static java.lang.String |
VSB_DOMAIN
Key for the domain for authenticating to the broker. |
static java.lang.String |
VSB_PASSWORD
Key for the password to log into the broker. |
static java.lang.String |
VSB_USERNAME
Key for the username to log into the broker |
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)
Returns a Map of candidate servers for a launch. |
IVirtualServerBroker.Scope |
getScope()
Gets the scope of this broker. |
void |
initialise(java.util.Map<java.lang.String,java.lang.String> initialisationParameters)
Initialises the broker using the given 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. |
Field Detail |
---|
static final java.lang.String DOMAIN
static final java.lang.String CONNECTION_PROTOCOL
static final java.lang.String VSB_USERNAME
static final java.lang.String SGD_IDENTITY
static final java.lang.String VSB_PASSWORD
static final java.lang.String VSB_DOMAIN
static final java.lang.String PARAMS
static final java.lang.String APP_NAME
static final java.lang.String DEFAULT_TYPE
static final java.lang.String SGD_IDENTITY_PREFIX_AD
static final java.lang.String SGD_IDENTITY_PREFIX_ANON
static final java.lang.String SGD_IDENTITY_PREFIX_ENS
static final java.lang.String SGD_IDENTITY_PREFIX_NTAUTH
static final java.lang.String SGD_IDENTITY_PREFIX_SECURID
static final java.lang.String SGD_IDENTITY_PREFIX_THIRDPARTY
static final java.lang.String SGD_IDENTITY_PREFIX_USER
static final java.lang.String[] SGD_IDENTITY_PREFIXES
static final java.lang.String NO_OVERRIDES_FAILOVER
Method Detail |
---|
void initialise(java.util.Map<java.lang.String,java.lang.String> initialisationParameters) throws VirtualServerBrokerAuthException, VirtualServerBrokerException
initialisationParameters
- The parameters to use when initialising
the broker.
VirtualServerBrokerException
- if there was a problem during
initialisation.
VirtualServerBrokerAuthException
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. The list of
candidates offered is based on the parameters specified. The
parameters recognised, and the effect they have, depend on
the implementing class.
The mapping is from the broker specified type,
see ICandidateServer.getType()
to a list ILaunchCandidates that support that type of application or
desktop.
Types are specific to brokers.
parameters
- The parameters that control which servers
are returned as candidates for this launch.
VirtualServerBrokerAuthException
- if there was a problem
authenticating with the broker.
VirtualServerBrokerException
- if there was a problem getting launch
candidates.ICandidateServer prepareCandidate(java.lang.String type, ICandidateServer candidateToPrepare) throws VirtualServerBrokerException
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.
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.getCandidateServers(java.util.Map)
boolean isAuthenticationRequired()
void destroy() throws VirtualServerBrokerException
VirtualServerBrokerException
IVirtualServerBroker.Scope getScope()
|
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 |