com.esri.gpt.sdisuite
Class IntegrationContext

java.lang.Object
  com.esri.gpt.sdisuite.IntegrationContext

Direct Known Subclasses:

SampleIntegrationContext

public abstract class IntegrationContext
extends Object

Provides an integration context for sde.suite components.

Constructor Summary

IntegrationContext()
Default constructor

Method Summary

abstract IntegrationResponse	checkUrl(String url, User user, String username, String password, String licenseReturnUrl) Authorizes access to a URL.
abstract void	ensureToken(User user) Ensure that the active user has a valid SAML token.
abstract String	getBase64EncodedToken(User user) Base64 encodes the SAML token associated with the active user.
StringAttributeMap	getConfig() Gets the configuration parameters.
String	getLicenseId(String licenseReference) Gets the license id associated with a license reference.
abstract String	getUsernameFromSAMLToken(String samlToken) Gets the username encoded within a SAML token.
abstract void	initializeUser(User user) Provides an opportunity to initialize additional user properties.
void	setConfig(StringAttributeMap config) Sets the configuration parameters.
abstract void	shutdown() Executed on web-app shutdown.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntegrationContext

public IntegrationContext()

Default constructor

Method Detail

getConfig

public StringAttributeMap getConfig()

Gets the configuration parameters.

Returns:

the configuration parameters

setConfig

public void setConfig(StringAttributeMap config)

Sets the configuration parameters.

Parameters:

config - the configuration parameters

checkUrl

public abstract IntegrationResponse checkUrl(String url,
                                             User user,
                                             String username,
                                             String password,
                                             String licenseReturnUrl)
                                      throws NotAuthorizedException,
                                             Exception

Authorizes access to a URL.

Parameters:

url - the URL

user - the active user

username - the username

password - the password

licenseReturnUrl - the return URL (called following license negotiation)

Returns:

the integration response

Throws:

NotAuthorizedException - if authorization for the supplied URL was denied

Exception - if a processing exception occurs

ensureToken

public abstract void ensureToken(User user)
                          throws Exception

Ensure that the active user has a valid SAML token.
This would typically be called following login.

Parameters:

user - the active user

Throws:

Exception - if an exception occurs

getBase64EncodedToken

public abstract String getBase64EncodedToken(User user)
                                      throws Exception

Base64 encodes the SAML token associated with the active user.
This would typically be called prior to launching an sdi.suite component.

Parameters:

user - the active user

Throws:

Exception - if an exception occurs

getLicenseId

public String getLicenseId(String licenseReference)
                    throws Exception

Gets the license id associated with a license reference.

Parameters:

licenseReference - the license reference

Returns:

the license id

Throws:

Exception - if an exception occurs

getUsernameFromSAMLToken

public abstract String getUsernameFromSAMLToken(String samlToken)
                                         throws Exception

Gets the username encoded within a SAML token.
This would typically be called when an external client executes a Geoportal request (e.g. when the smart editor saves, a SAML token is passed as part of the SOAP request)

Parameters:

samlToken - the SAML token

Throws:

Exception - if an exception occurs

initializeUser

public abstract void initializeUser(User user)
                             throws Exception

Provides an opportunity to initialize additional user properties.
Called following login (?? following authentication ?? prior to ??).

Parameters:

user - the active user

Throws:

Exception - if an exception occurs

shutdown

public abstract void shutdown()
                       throws Exception

Executed on web-app shutdown.

Throws:

Exception - if an exception occurs