com.ibm.wps.portletservice.credentialvault.credentials
Class SiteMinderTokenCredential
java.lang.Object
com.ibm.wps.portletservice.credentialvault.credentials.Credential
com.ibm.wps.portletservice.credentialvault.credentials.ActiveCredential
com.ibm.wps.portletservice.credentialvault.credentials.JaasSubjectCredential
com.ibm.wps.portletservice.credentialvault.credentials.SiteMinderTokenCredential
- All Implemented Interfaces:
- ActiveCredential, Credential, JaasSubjectCredential, SiteMinderTokenCredential, java.io.Serializable
Deprecated. since 6.0. Support of the IBM portlet API may be removed in a future
release of WebSphere Portal. Use of the Java Portlet API (javax.portlet)
is recommended instead.
public class SiteMinderTokenCredential
- extends JaasSubjectCredential
- implements SiteMinderTokenCredential
Credential for authenticating at a back-end system that is within the same SiteMinder SSO-Domain as the portal,
i.e. you are using an SiteMinder authentication proxy for the portal authentiation.
The credential needs to be provided in form of the portal's JAAS Subject
, containing a private
credential that holds the user's SiteMinderSessionPrincipal.
To be used in following way:
- Construct (initialize) the credential
- Pass an HttpURLConnection to the credential in order to add the SiteMinderSessionPrincipal to the request header ("getAuthenticatedConnection")
- If necessary, set aditional HTTP headers
- Send the request
Preconditions:
- The configuration data passed to the constructor must define the values that are
required by
JaasSubjectCredential
Assumptions:
- If the Url uses SSL (https://) the JSSE has already been registered
- Since:
- WP 5.1.0.1
- See Also:
- Serialized Form
Fields inherited from class com.ibm.wps.portletservice.credentialvault.credentials.Credential |
LOGGER_NAME |
Method Summary |
java.net.HttpURLConnection |
getAuthenticatedConnection(java.lang.String url)
Deprecated. Returns a new Http URL connection with added authentication data. |
java.net.HttpURLConnection |
getAuthenticatedConnection(java.net.URL url)
Deprecated. Returns a new HttpURLConnection with added authentication data. |
void |
init(java.util.Map<java.lang.String,java.lang.Object> config)
Deprecated. Creates a new SiteMinderToken credential. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
sessionPrincipalString
protected java.lang.String sessionPrincipalString
- Deprecated.
SiteMinderTokenCredential
public SiteMinderTokenCredential()
- Deprecated.
init
public void init(java.util.Map<java.lang.String,java.lang.Object> config)
throws CredentialVaultException
- Deprecated.
- Creates a new SiteMinderToken credential.
- Specified by:
init
in interface Credential
- Specified by:
init
in interface JaasSubjectCredential
- Specified by:
init
in interface SiteMinderTokenCredential
- Overrides:
init
in class JaasSubjectCredential
- Parameters:
config
- The configuration needed to initialize this credential:
- KEY_CREDENTIAL_SECRET JaasSubjectCredentialSecret - the credential's secret (mandatory)
- Throws:
CredentialVaultException
- If any mandatory parameter is missing or has a wrong object type as value.
getAuthenticatedConnection
public java.net.HttpURLConnection getAuthenticatedConnection(java.net.URL url)
throws java.io.IOException
- Deprecated.
- Returns a new HttpURLConnection with added authentication data.
- Specified by:
getAuthenticatedConnection
in interface JaasSubjectCredential
- Specified by:
getAuthenticatedConnection
in interface SiteMinderTokenCredential
- Specified by:
getAuthenticatedConnection
in class JaasSubjectCredential
- Parameters:
url
- The target URL for the connection. Note that it need not be opened yet.
- Returns:
- HttpURLConnection
A new authenticated (and yet uncommitted) connection
- Throws:
java.io.IOException
- thrown if anything unexpected happened
getAuthenticatedConnection
public java.net.HttpURLConnection getAuthenticatedConnection(java.lang.String url)
throws java.io.IOException
- Deprecated.
- Returns a new Http URL connection with added authentication data.
- Specified by:
getAuthenticatedConnection
in interface JaasSubjectCredential
- Specified by:
getAuthenticatedConnection
in interface SiteMinderTokenCredential
- Specified by:
getAuthenticatedConnection
in class JaasSubjectCredential
- Parameters:
url
- The target URL for the connection.
- Returns:
- HttpURLConnection
A new authenticated (and yet uncommitted) connection.
- Throws:
java.io.IOException
- thrown if anything unexpected happened.