com.adaptris.core.http.client.net

Class ConfiguredAuthorizationHeader

java.lang.Object

com.adaptris.core.http.client.net.ConfiguredAuthorizationHeader

All Implemented Interfaces:

HttpAuthenticator, HttpURLConnectionAuthenticator, java.lang.AutoCloseable

public class ConfiguredAuthorizationHeader
extends java.lang.Object
implements HttpURLConnectionAuthenticator

Build an HttpConstants.AUTHORIZATION header from static data.

In the adapter configuration file this class is aliased as http-configured-authorization-header which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
ConfiguredAuthorizationHeader()

Method Summary

Modifier and Type	Method and Description
void	close() Undo whatever global state modifications have been made by this HttpAuthenticator.
void	configureConnection(java.net.HttpURLConnection conn) Perform whatever actions are required to the HttpURLConnection after it's been opened (setting custom headers, etc).
java.lang.String	getHeaderValue()
void	setHeaderValue(java.lang.String headerValue) The value for the authorization header
void	setup(java.lang.String target, AdaptrisMessage msg, ResourceTargetMatcher auth) Initialize the HttpAuthenticator for a message and return.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfiguredAuthorizationHeader

public ConfiguredAuthorizationHeader()

Method Detail

getHeaderValue

public java.lang.String getHeaderValue()

setHeaderValue

public void setHeaderValue(java.lang.String headerValue)

The value for the authorization header

Parameters:

headerValue - the header value, supports metadata resolution via InterlokMessage.resolve(String).

setup

public void setup(java.lang.String target,
                  AdaptrisMessage msg,
                  ResourceTargetMatcher auth)
           throws CoreException

Description copied from interface: HttpAuthenticator

Initialize the HttpAuthenticator for a message and return. Any global state mutations should be done here.

Specified by:

setup in interface HttpAuthenticator

Parameters:

target - The URL to set authenticate for

msg - The message to set up for

auth - the ResourceTargetMatcher to use, if null a default one will be created based on the ResourceAuthenticator.ResourceTarget.getRequestingURL()

Throws:

CoreException

configureConnection

public void configureConnection(java.net.HttpURLConnection conn)

Description copied from interface: HttpURLConnectionAuthenticator

Perform whatever actions are required to the HttpURLConnection after it's been opened (setting custom headers, etc). Not all implementations of this interface will have something to do here.

Specified by:

configureConnection in interface HttpURLConnectionAuthenticator

close

public void close()

Description copied from interface: HttpAuthenticator

Undo whatever global state modifications have been made by this HttpAuthenticator.

Specified by:

close in interface HttpAuthenticator

Specified by:

close in interface java.lang.AutoCloseable