org.openid4java.message
Interface MessageExtension

All Known Implementing Classes:
AxMessage, AxPayload, FetchRequest, FetchResponse, PapeMessage, PapeRequest, PapeResponse, SRegMessage, SRegRequest, SRegResponse, StoreRequest, StoreResponse

public interface MessageExtension

Interface for building OpenID extensions.

Classes that implement this interface should provide a default constructor and register their Type URIs with the MessageExtensionFactory.

Author:
Marius Scurtescu, Johnny Bufu
See Also:
Message

Method Summary
 ParameterList getParameters()
          Gets the extension-specific parameters.
 java.lang.String getTypeUri()
          Gets the TypeURI that identifies a extension to the OpenID protocol.
 boolean providesIdentifier()
          Used by the core OpenID authentication implementation to learn whether an extension provies authentication services.
 void setParameters(ParameterList params)
          Sets the extension-specific parameters.
 boolean signRequired()
          Flag for indicating that an extension must be signed.
 

Method Detail

getTypeUri

java.lang.String getTypeUri()
Gets the TypeURI that identifies a extension to the OpenID protocol.


getParameters

ParameterList getParameters()
Gets the extension-specific parameters.

Implementations MUST NOT prefix the parameter names with "openid.". The alias is managed internally by the Message class, when a extension is attached to an OpenID messaage.

See Also:
Message

setParameters

void setParameters(ParameterList params)
Sets the extension-specific parameters.

Implementations MUST NOT prefix the parameter names with "openid.". The alias is managed internally by the Message class, when a extension is attached to an OpenID messaage.

Parameters:
params -
See Also:
Message

providesIdentifier

boolean providesIdentifier()
Used by the core OpenID authentication implementation to learn whether an extension provies authentication services.

If the extension provides authentication services, the 'openid.identity' and 'openid.signed' parameters are optional.

Returns:
True if the extension provides authentication services, false otherwise.

signRequired

boolean signRequired()
Flag for indicating that an extension must be signed.

Returns:
True if all the extension's parameters MUST be signed in positive assertions, or false if there isn't such a requirement.


Copyright © 2011 Sxip. All Rights Reserved.