org.apache.synapse.endpoints.auth

Interface AuthHandler

All Known Implementing Classes:

AuthorizationCodeHandler, BasicAuthHandler, ClientCredentialsHandler, OAuthHandler, PasswordCredentialsHandler

public interface AuthHandler

Method Summary

Modifier and Type	Method and Description
String	getAuthType() Gets the auth handler type of the instance.
void	setAuthHeader(MessageContext messageContext) This method will set the Authorization header with the relevant auth token.

Method Detail

getAuthType

String getAuthType()

Gets the auth handler type of the instance.

setAuthHeader

void setAuthHeader(MessageContext messageContext)
            throws AuthException

This method will set the Authorization header with the relevant auth token.

Parameters:

messageContext - Message context to which the token needs to be set

Throws:

AuthException - In the event of errors when generating new token