|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.extensions.surf.FrameworkUtil
public final class FrameworkUtil
Static methods which are useful for working with services and beans within the Web Framework.
Constructor Summary | |
---|---|
FrameworkUtil()
|
Method Summary | |
---|---|
static WebFrameworkConfigElement |
getConfig()
Retrieves the web framework configuration. |
static ConfigService |
getConfigService()
Gets the config service. |
static Connector |
getConnector(javax.servlet.http.HttpSession httpSession,
String userId,
String endpointId)
Creates an authenticated connector to a given endpoint. |
static Connector |
getConnector(RequestContext context,
String endpointId)
Creates an authenticated connector to a given endpoint. |
static Connector |
getConnector(String endpointId)
Creates an unauthenticated connector to a given endpoint. |
static ConnectorService |
getConnectorService()
Retrieves the connector service. |
static ConnectorSession |
getConnectorSession(javax.servlet.http.HttpSession httpSession,
String endpointId)
Retrieves the Connector Session instance for the current session and given endpoint. |
static ConnectorSession |
getConnectorSession(RequestContext context,
String endpointId)
Retrieves the Connector Session instance for the current user and given endpoint. |
static CredentialVault |
getCredentialVault(javax.servlet.http.HttpSession httpSession,
String userId)
Retrieves the session-bound credential vault for a given user. |
static CredentialVault |
getCredentialVault(RequestContext context,
String userId)
Retrieves the session-bound credential vault for a given user. |
static RequestContext |
getCurrentRequestContext()
Retrieves the request context for the current thread. |
static RemoteConfigElement.EndpointDescriptor |
getEndpoint(String endpointId)
Loads the endpoint descriptor for a given endpoint. |
static String |
getFrameworkTitle()
Returns the official title of this release of the Alfresco Web Framework |
static String |
getFrameworkVersion()
Returns the official version of this release of the Alfresco Web Framework |
static org.apache.commons.logging.Log |
getLogger()
Retrieves the general web framework logger. |
static RemoteConfigElement |
getRemoteConfiguration()
Retrieves the web framework remote configuration. |
static RenderService |
getRenderService()
Gets the render service. |
static ResourceLoader |
getResourceLoader(String objectId,
String endpointId)
Produces a ResourceLoader for the given object id on a given endpoint |
static ResourceService |
getResourceService()
Gets the resource service. |
static WebFrameworkServiceRegistry |
getServiceRegistry()
Retrieves the web framework services registry. |
static WebFrameworkConfigElement |
getWebFrameworkConfiguration()
Retrieves the web framework configuration. |
static void |
logFullStacktrace(Throwable throwable)
Tells the web flow application context to refresh This will reload all web flow beans |
static void |
removeConnectorSessions(RequestContext context)
Removes all session-bound Connector Sessions for the current user |
static void |
resetWebScripts()
Helper function to reset all web scripts in the web framework web scripts container |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FrameworkUtil()
Method Detail |
---|
public static RequestContext getCurrentRequestContext()
public static WebFrameworkServiceRegistry getServiceRegistry()
public static ConfigService getConfigService()
public static WebFrameworkConfigElement getWebFrameworkConfiguration()
public static WebFrameworkConfigElement getConfig()
public static RemoteConfigElement getRemoteConfiguration()
public static ConnectorService getConnectorService()
public static RenderService getRenderService()
public static ResourceService getResourceService()
public static org.apache.commons.logging.Log getLogger()
public static RemoteConfigElement.EndpointDescriptor getEndpoint(String endpointId)
endpointId
- the endpoint id
public static Connector getConnector(String endpointId) throws ConnectorServiceException
endpointId
- endpoint id
ConnectorServiceException
- the connector service exceptionpublic static Connector getConnector(RequestContext context, String endpointId) throws ConnectorServiceException
context
- the request contextendpointId
- the endpoint
ConnectorServiceException
- the connector service exceptionpublic static Connector getConnector(javax.servlet.http.HttpSession httpSession, String userId, String endpointId) throws ConnectorServiceException
httpSession
- the http sessionuserId
- the user idendpointId
- the endpoint id
ConnectorServiceException
- the connector service exceptionpublic static CredentialVault getCredentialVault(javax.servlet.http.HttpSession httpSession, String userId)
httpSession
- the http sessionuserId
- the user id
public static CredentialVault getCredentialVault(RequestContext context, String userId)
context
- the contextuserId
- the user id
public static ConnectorSession getConnectorSession(RequestContext context, String endpointId)
context
- the contextendpointId
- the endpoint id
public static ConnectorSession getConnectorSession(javax.servlet.http.HttpSession httpSession, String endpointId)
httpSession
- the http sessionendpointId
- the endpoint id
public static void removeConnectorSessions(RequestContext context)
context
- the contextpublic static String getFrameworkTitle()
public static String getFrameworkVersion()
public static ResourceLoader getResourceLoader(String objectId, String endpointId)
objectId
- the object idendpointId
- the endpoint id
public static void resetWebScripts()
public static void logFullStacktrace(Throwable throwable)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |