org.jasig.cas.authentication

Class HttpBasedServiceCredential

java.lang.Object

org.jasig.cas.authentication.AbstractCredential

org.jasig.cas.authentication.HttpBasedServiceCredential

All Implemented Interfaces:

Serializable, Credential, CredentialMetaData

public class HttpBasedServiceCredential
extends AbstractCredential

A credential representing an HTTP endpoint given by a URL. Authenticating the credential usually involves contacting the endpoint via the URL and observing the resulting connection (e.g. SSL certificate) and response (e.g. status, headers).

Since:

3.0

Author:

Scott Battaglia, Marvin S. Addison

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.jasig.cas.authentication.Credential

UNKNOWN_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpBasedServiceCredential() Empty constructor used by Kryo for de-serialization.
	HttpBasedServiceCredential(URL callbackUrl) Creates a new instance for an HTTP endpoint located at the given URL.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
URL	getCallbackUrl()
String	getId() Gets a credential identifier that is safe to record for logging, auditing, or presentation to the user.
int	hashCode()

Methods inherited from class org.jasig.cas.authentication.AbstractCredential

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpBasedServiceCredential

protected HttpBasedServiceCredential()

Empty constructor used by Kryo for de-serialization.

HttpBasedServiceCredential

public HttpBasedServiceCredential(URL callbackUrl)

Creates a new instance for an HTTP endpoint located at the given URL.

Parameters:

callbackUrl - Non-null URL that will be contacted to validate the credential.

Throws:

IllegalArgumentException - if the callbackUrl is null.

Method Detail

getId

public String getId()

Gets a credential identifier that is safe to record for logging, auditing, or presentation to the user. In most cases this has a natural meaning for most credential types (e.g. username, certificate DN), while for others it may be awkward to construct a meaningful identifier. In any case credentials require some means of identification for a number of cases and implementers should make a best effor to satisfy that need.

Returns:

Non-null credential identifier. Implementers should return Credential.UNKNOWN_ID for cases where an ID is not readily available or meaningful.

getCallbackUrl

public final URL getCallbackUrl()

Returns:

Returns the callbackUrl.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractCredential

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractCredential