|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.extensions.webscripts.connector.ConnectorService
public class ConnectorService
The ConnectorService acts as a singleton that can be used to build any of the objects utilized by the Connector layer.
This class is mounted as a Spring Bean within the Web Script Framework so that developers can access it from the application context.
Constructor Summary | |
---|---|
ConnectorService()
|
Method Summary | |
---|---|
Authenticator |
getAuthenticator(String id)
Returns the implementation of an Authenticator with a given id |
ConfigService |
getConfigService()
Gets the config service. |
Connector |
getConnector(String endpointId)
Retrieves a Connector to a given endpoint. |
Connector |
getConnector(String endpointId,
javax.servlet.http.HttpSession session)
Retrieves a Connector to a given endpoint. |
Connector |
getConnector(String endpointId,
String userId,
javax.servlet.http.HttpSession session)
Retrieves a Connector for the given endpoint that is scoped to the given user. |
Connector |
getConnector(String endpointId,
UserContext userContext,
javax.servlet.http.HttpSession session)
Retrieves a Connector for the given endpoint that is scoped to the given user context. |
ConnectorSession |
getConnectorSession(javax.servlet.http.HttpSession session,
String endpointId)
Returns the ConnectorSession bound to the current HttpSession for the given endpoint |
CredentialVault |
getCredentialVault(javax.servlet.http.HttpSession session,
String userId)
Retrieves the user-scoped CredentialVault for the given user If a vault doesn't yet exist, a vault of the default type will be instantiated |
CredentialVault |
getCredentialVault(javax.servlet.http.HttpSession session,
String userId,
String vaultProviderId)
Retrieves the user-scoped CredentialVault for the given user id and given vault id |
void |
onApplicationEvent(org.springframework.context.ApplicationEvent event)
|
void |
removeConnectorSession(javax.servlet.http.HttpSession session,
String endpointId)
Removes the ConnectorSession from the HttpSession for the given endpoint |
void |
setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
Sets the application config |
void |
setConfigService(ConfigService configService)
Sets the config service. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConnectorService()
Method Detail |
---|
public void setConfigService(ConfigService configService)
configService
- the new config servicepublic void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
setApplicationContext
in interface org.springframework.context.ApplicationContextAware
applicationContxt
- the application contextpublic ConfigService getConfigService()
public void onApplicationEvent(org.springframework.context.ApplicationEvent event)
onApplicationEvent
in interface org.springframework.context.ApplicationListener
public Connector getConnector(String endpointId) throws ConnectorServiceException
This Connector has no given user context and will not pass any authentication credentials. Therefore only endpoints that do not require authentication or have "declared" authentication as part of the endpoint config should be used. This Connector also will not manage connector session state. Thus, it is generally less preferred to use these connectors over those provided by getConnector(endpointId, session)
endpointId
- the endpoint id
ConnectorServiceException
public Connector getConnector(String endpointId, javax.servlet.http.HttpSession session) throws ConnectorServiceException
This Connector has no given user context and will not pass any authentication credentials. Therefore only endpoints that do not require authentication or have "declared" authentication as part of the endpoint config should be used. Cookie and token state will be session bound and reusable on subsequent invocations.
endpointId
- the endpoint idsession
- the HTTP session
ConnectorServiceException
public Connector getConnector(String endpointId, String userId, javax.servlet.http.HttpSession session) throws ConnectorServiceException
If the provided endpoint is configured to use an Authenticator, then the Connector instance returned will be wrapped as an AuthenticatingConnector.
Cookie and token state will be session bound and reusable on subsequent invocations.
endpointId
- the endpoint iduserId
- the user id (optional)session
- the session
ConnectorServiceException
public Connector getConnector(String endpointId, UserContext userContext, javax.servlet.http.HttpSession session) throws ConnectorServiceException
A user context is a means of wrapping the Credentials and ConnectorSession objects for a given user. If they are provided, then context will be drawn from them and stored back.
endpointId
- the endpoint iduserContext
- the user contextsession
- the http session
ConnectorServiceException
public Authenticator getAuthenticator(String id) throws ConnectorServiceException
id
- the id
ConnectorServiceException
public ConnectorSession getConnectorSession(javax.servlet.http.HttpSession session, String endpointId)
session
- the sessionendpointId
- the endpoint id
public void removeConnectorSession(javax.servlet.http.HttpSession session, String endpointId)
session
- the sessionendpointId
- the endpoint idpublic CredentialVault getCredentialVault(javax.servlet.http.HttpSession session, String userId) throws CredentialVaultProviderException
userId
- the user id
CredentialVaultProviderException
- the credential vault provider exceptionpublic CredentialVault getCredentialVault(javax.servlet.http.HttpSession session, String userId, String vaultProviderId) throws CredentialVaultProviderException
userId
- the user idvaultProviderId
- the vault provider id
CredentialVaultProviderException
- the credential vault provider exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |