org.miniauth.oauth.service

Class OAuthRequestEndorser

java.lang.Object

org.miniauth.oauth.service.OAuthRequestEndorser

All Implemented Interfaces:

Serializable, RequestEndorser

public class OAuthRequestEndorser
extends Object
implements RequestEndorser, Serializable

OAuth Request signer implementation. (Using a generic/broader term "endorse" instead of "sign" for future generalization.)

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
boolean	endorse(AccessCredential credential, OutgoingRequest request) Returns true if the oauthRequest has been successfully "endorsed".
static OAuthRequestEndorser	getInstance()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static OAuthRequestEndorser getInstance()

endorse

public boolean endorse(AccessCredential credential,
              OutgoingRequest request)
                throws MiniAuthException

Returns true if the oauthRequest has been successfully "endorsed". (Note: it never returns false. If error occurs, it throws exceptions.)

Specified by:

endorse in interface RequestEndorser

Parameters:

credential - Access credential needed to endorse/sign the request.

request - Outgoing request wrapper object. "In-out" param. It should be in a "ready" state.

Returns:

true if the operation was successful.

Throws:

MiniAuthException