com.adaptris.core.http.auth

Interface HttpAuthenticator

All Superinterfaces:

java.lang.AutoCloseable

All Known Subinterfaces:

HttpURLConnectionAuthenticator

All Known Implementing Classes:

ConfiguredAuthorizationHeader, ConfiguredUsernamePassword, DynamicBasicAuthorizationHeader, MetadataAuthorizationHeader, MetadataUsernamePassword, NoAuthentication, UserPassAuthentication

public interface HttpAuthenticator
extends java.lang.AutoCloseable

HttpAuthenticator is an interface designed to facilitate HttpAuthentication in various ways.

Some implementations of this interface will need to temporarily mutate global state and therefore must be closed in a finally statement or try-with-resources block.

Method Summary

Modifier and Type	Method and Description
void	close() Undo whatever global state modifications have been made by this HttpAuthenticator.
void	setup(java.lang.String target, AdaptrisMessage msg, ResourceTargetMatcher auth) Initialize the HttpAuthenticator for a message and return.

Method Detail

setup

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

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

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

close

void close()

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

Specified by:

close in interface java.lang.AutoCloseable