|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.wps.portletservice.credentialvault.credentials.Credential com.ibm.wps.portletservice.credentialvault.credentials.ActiveCredential com.ibm.wps.portletservice.credentialvault.credentials.UserPasswordCredential com.ibm.wps.portletservice.credentialvault.credentials.HttpFormBasedAuthCredential
public class HttpFormBasedAuthCredential
Credential for authenticating at the back-end via Http Form Based authentication. To be used in following way:
UserPasswordCredential
)
Field Summary | |
---|---|
static java.lang.String |
KEY_FORM_DATA
Deprecated. |
static java.lang.String |
KEY_LOGIN_URL
Deprecated. |
static java.lang.String |
KEY_LOGOUT_URL
Deprecated. |
static java.lang.String |
KEY_PASSWORD_ATTRIBUTE_NAME
Deprecated. |
static java.lang.String |
KEY_USE_AUTH_COOKIES
Deprecated. |
static java.lang.String |
KEY_USERID_ATTRIBUTE_NAME
Deprecated. |
Fields inherited from class com.ibm.wps.portletservice.credentialvault.credentials.UserPasswordCredential |
---|
secret |
Fields inherited from class com.ibm.wps.portletservice.credentialvault.credentials.Credential |
---|
LOGGER_NAME |
Fields inherited from interface com.ibm.portal.portlet.service.credentialvault.credentials.Credential |
---|
KEY_CREDENTIAL_SECRET |
Constructor Summary | |
---|---|
HttpFormBasedAuthCredential()
Deprecated. |
Method Summary | |
---|---|
java.net.HttpURLConnection |
getAuthenticatedConnection(java.lang.String url)
Deprecated. Returns a new HttpURLConnection 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 HttpFormBasedAuth credential. |
java.net.HttpURLConnection |
login()
Deprecated. Performs the HTTP form based login. |
java.net.HttpURLConnection |
logout()
Deprecated. Performs the logout through an HTTP GET request to the logoutUrl. |
Methods inherited from class com.ibm.wps.portletservice.credentialvault.credentials.UserPasswordCredential |
---|
getSecretType |
Methods inherited from class com.ibm.wps.portletservice.credentialvault.credentials.ActiveCredential |
---|
isActive |
Methods inherited from class com.ibm.wps.portletservice.credentialvault.credentials.Credential |
---|
checkInitialized |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.portal.portlet.service.credentialvault.credentials.UserPasswordCredential |
---|
getSecretType |
Methods inherited from interface com.ibm.portal.portlet.service.credentialvault.credentials.ActiveCredential |
---|
isActive |
Field Detail |
---|
public static final java.lang.String KEY_USERID_ATTRIBUTE_NAME
public static final java.lang.String KEY_PASSWORD_ATTRIBUTE_NAME
public static final java.lang.String KEY_LOGIN_URL
public static final java.lang.String KEY_LOGOUT_URL
public static final java.lang.String KEY_FORM_DATA
public static final java.lang.String KEY_USE_AUTH_COOKIES
Constructor Detail |
---|
public HttpFormBasedAuthCredential()
Method Detail |
---|
public void init(java.util.Map<java.lang.String,java.lang.Object> config) throws CredentialVaultException
init
in interface Credential
init
in interface HttpFormBasedAuthCredential
init
in interface UserPasswordCredential
init
in class UserPasswordCredential
config
- The configuration that is needed to initialize this credential:
name=value
pairs that need to be posted with the login POST (optional)CredentialVaultException
- If any mandatory parameter is missing or has a wrong object type as value.public java.net.HttpURLConnection login() throws java.io.IOException
login
in interface HttpFormBasedAuthCredential
java.io.IOException
- if the login failed or no cookie has been returned.public java.net.HttpURLConnection logout() throws java.io.IOException
logout
in interface HttpFormBasedAuthCredential
java.io.IOException
- if the logout failed or credential status is not 'logged in'.public java.net.HttpURLConnection getAuthenticatedConnection(java.lang.String url) throws java.io.IOException
getAuthenticatedConnection
in interface HttpFormBasedAuthCredential
url
- the target URL for the connection.
java.io.IOException
- thrown if anything unexpected happens.public java.net.HttpURLConnection getAuthenticatedConnection(java.net.URL url) throws java.io.IOException
getAuthenticatedConnection
in interface HttpFormBasedAuthCredential
url
- the target URL for the connection. Note that it need not be opened yet.
Note also that this method may only be called if cookies are used for authentication.
java.io.IOException
- thrown if anything unexpected happens.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |