org.springframework.extensions.surf

Class FrameworkBean

java.lang.Object

org.springframework.extensions.surf.FrameworkBean

public final class FrameworkBean
extends Object

Static methods which are useful for working with services and beans within the Web Framework.

Author:

David Draper

Constructor Summary

Constructors

Constructor and Description
FrameworkBean()

Method Summary

Methods

Modifier and Type	Method and Description
static WebFrameworkConfigElement	getConfig() Deprecated.
org.springframework.extensions.webscripts.connector.Connector	getConnector(javax.servlet.http.HttpSession httpSession, String userId, String endpointId) Creates an authenticated connector to a given endpoint.
org.springframework.extensions.webscripts.connector.Connector	getConnector(RequestContext context, String endpointId) Creates an authenticated connector to a given endpoint.
org.springframework.extensions.webscripts.connector.Connector	getConnector(String endpointId) Creates an unauthenticated connector to a given endpoint.
org.springframework.extensions.webscripts.connector.ConnectorSession	getConnectorSession(javax.servlet.http.HttpSession httpSession, String endpointId) Retrieves the Connector Session instance for the current session and given endpoint.
org.springframework.extensions.webscripts.connector.ConnectorSession	getConnectorSession(RequestContext context, String endpointId) Retrieves the Connector Session instance for the current user and given endpoint.
org.springframework.extensions.webscripts.connector.CredentialVault	getCredentialVault(javax.servlet.http.HttpSession httpSession, String userId) Retrieves the session-bound credential vault for a given user.
org.springframework.extensions.webscripts.connector.CredentialVault	getCredentialVault(RequestContext context, String userId) Retrieves the session-bound credential vault for a given user.
org.springframework.extensions.config.RemoteConfigElement.EndpointDescriptor	getEndpoint(String endpointId) Loads the endpoint descriptor for a given endpoint.
static RenderService	getRenderService() Deprecated.
static ResourceService	getResourceService() Deprecated.
static WebFrameworkServiceRegistry	getServiceRegistry() Deprecated.
void	logFullStacktrace(Throwable throwable)
void	removeConnectorSessions(RequestContext context) Removes all session-bound Connector Sessions for the current user
void	resetWebScripts() Helper function to reset all web scripts in the web framework web scripts container
void	setConnectorService(org.springframework.extensions.webscripts.connector.ConnectorService connectorService)
void	setRemoteConfig(org.springframework.extensions.config.RemoteConfigElement remoteConfig)
void	setWebFrameworkContainer(org.springframework.extensions.webscripts.Container container)

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameworkBean

public FrameworkBean()

Method Detail

setWebFrameworkContainer

public void setWebFrameworkContainer(org.springframework.extensions.webscripts.Container container)

setRemoteConfig

public void setRemoteConfig(org.springframework.extensions.config.RemoteConfigElement remoteConfig)

setConnectorService

public void setConnectorService(org.springframework.extensions.webscripts.connector.ConnectorService connectorService)

getServiceRegistry

public static WebFrameworkServiceRegistry getServiceRegistry()

Deprecated.

Retrieves the web framework services registry.

Returns:

WebFrameworkServiceRegistry

getConfig

public static WebFrameworkConfigElement getConfig()

Deprecated.

Returns:

WebFrameworkConfigElement

getRenderService

public static RenderService getRenderService()

Deprecated.

Gets the render service.

Returns:

the render service

getResourceService

public static ResourceService getResourceService()

Deprecated.

Gets the resource service.

Returns:

the resource service

getEndpoint

public org.springframework.extensions.config.RemoteConfigElement.EndpointDescriptor getEndpoint(String endpointId)

Loads the endpoint descriptor for a given endpoint.

Parameters:

endpointId - the endpoint id

Returns:

the descriptor

getConnector

public org.springframework.extensions.webscripts.connector.Connector getConnector(String endpointId)
                                                                           throws org.springframework.extensions.surf.exception.ConnectorServiceException

Creates an unauthenticated connector to a given endpoint.

Parameters:

endpointId - endpoint id

Returns:

the connector

Throws:

org.springframework.extensions.surf.exception.ConnectorServiceException - the connector service exception

getConnector

public org.springframework.extensions.webscripts.connector.Connector getConnector(RequestContext context,
                                                                         String endpointId)
                                                                           throws org.springframework.extensions.surf.exception.ConnectorServiceException

Creates an authenticated connector to a given endpoint.

Parameters:

context - the request context

endpointId - the endpoint

Returns:

the connector

Throws:

org.springframework.extensions.surf.exception.ConnectorServiceException - the connector service exception

getConnector

public org.springframework.extensions.webscripts.connector.Connector getConnector(javax.servlet.http.HttpSession httpSession,
                                                                         String userId,
                                                                         String endpointId)
                                                                           throws org.springframework.extensions.surf.exception.ConnectorServiceException

Creates an authenticated connector to a given endpoint.

Parameters:

httpSession - the http session

userId - the user id

endpointId - the endpoint id

Returns:

the connector

Throws:

org.springframework.extensions.surf.exception.ConnectorServiceException - the connector service exception

getCredentialVault

public org.springframework.extensions.webscripts.connector.CredentialVault getCredentialVault(javax.servlet.http.HttpSession httpSession,
                                                                                     String userId)

Retrieves the session-bound credential vault for a given user.

Parameters:

httpSession - the http session

userId - the user id

Returns:

the credential vault

getCredentialVault

public org.springframework.extensions.webscripts.connector.CredentialVault getCredentialVault(RequestContext context,
                                                                                     String userId)

Retrieves the session-bound credential vault for a given user.

Parameters:

context - the context

userId - the user id

Returns:

the credential vault

getConnectorSession

public org.springframework.extensions.webscripts.connector.ConnectorSession getConnectorSession(RequestContext context,
                                                                                       String endpointId)

Retrieves the Connector Session instance for the current user and given endpoint.

Parameters:

context - the context

endpointId - the endpoint id

Returns:

the connector session

getConnectorSession

public org.springframework.extensions.webscripts.connector.ConnectorSession getConnectorSession(javax.servlet.http.HttpSession httpSession,
                                                                                       String endpointId)

Retrieves the Connector Session instance for the current session and given endpoint.

Parameters:

httpSession - the http session

endpointId - the endpoint id

Returns:

the connector session

removeConnectorSessions

public void removeConnectorSessions(RequestContext context)

Removes all session-bound Connector Sessions for the current user

Parameters:

context - the context

resetWebScripts

public void resetWebScripts()

Helper function to reset all web scripts in the web framework web scripts container

logFullStacktrace

public void logFullStacktrace(Throwable throwable)