com.boomi.connector.util.network

Class SimpleNetworkAuthenticator

java.lang.Object

com.boomi.connector.util.network.SimpleNetworkAuthenticator

All Implemented Interfaces:

NetworkAuthenticator

public final class SimpleNetworkAuthenticator
extends Object
implements NetworkAuthenticator

Simple NetworkAuthenticator implementation for connectors. Instances use a single PasswordAuthentication instance which is not dependent on the NetworkAuthenticatorContext with one exception. The requestPasswordAuthentication(NetworkAuthenticatorContext) method only supports the Authenticator.RequestorType#SERVER requestor type. Requests made to requestPasswordAuthentication(NetworkAuthenticatorContext) for other requestor types will return null.

Constructor Summary

Constructors

Constructor and Description
SimpleNetworkAuthenticator(PasswordAuthentication passwordAuthentication) Creates a new instance with the PasswordAuthentication instance that will be used for all authentication requests.
SimpleNetworkAuthenticator(String userName, String password) Creates a new instance with a user name and password that will be used for all authentication requests.

Method Summary

Modifier and Type	Method and Description
PasswordAuthentication	requestPasswordAuthentication(NetworkAuthenticatorContext connectorAuthenticatorContext) This method is used to request a PasswordAuthentication instance based on the specified context.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleNetworkAuthenticator

public SimpleNetworkAuthenticator(String userName,
                                  String password)

Creates a new instance with a user name and password that will be used for all authentication requests. The password is required to be non-null.

Parameters:

userName - the user name

password - the password

SimpleNetworkAuthenticator

public SimpleNetworkAuthenticator(PasswordAuthentication passwordAuthentication)

Creates a new instance with the PasswordAuthentication instance that will be used for all authentication requests.

Parameters:

passwordAuthentication - the password authentication instance

Method Detail

requestPasswordAuthentication

public PasswordAuthentication requestPasswordAuthentication(NetworkAuthenticatorContext connectorAuthenticatorContext)

Description copied from interface: NetworkAuthenticator

This method is used to request a PasswordAuthentication instance based on the specified context. Implementations should use the information in the provided context to determine the correct credentials for the request.

Specified by:

requestPasswordAuthentication in interface NetworkAuthenticator

Parameters:

connectorAuthenticatorContext - NetworkAuthenticatorContext with authentication request details

Returns:

PasswordAuthentication with user credentials if authentication is required for the network connection, null otherwise