org.eclipse.milo.opcua.sdk.server.identity

Class AbstractUsernameIdentityValidator<T>

java.lang.Object

org.eclipse.milo.opcua.sdk.server.identity.AbstractIdentityValidator<T>

org.eclipse.milo.opcua.sdk.server.identity.AbstractUsernameIdentityValidator<T>

All Implemented Interfaces:

IdentityValidator<T>

Direct Known Subclasses:

UsernameIdentityValidator

public abstract class AbstractUsernameIdentityValidator<T>
extends AbstractIdentityValidator<T>

Constructor Summary

Constructors

Constructor and Description
AbstractUsernameIdentityValidator()

Method Summary

Modifier and Type	Method and Description
protected abstract T	authenticateAnonymous(Session session) Create and return an identity object for an anonymous user.
protected abstract T	authenticateUsernamePassword(Session session, String username, String password) Authenticate username with password, returning an identity object of type T if the authentication succeeded, or null if the authentication failed.
protected T	validateAnonymousToken(Session session, AnonymousIdentityToken token, UserTokenPolicy tokenPolicy, SignatureData tokenSignature) Validate an AnonymousIdentityToken and return an identity Object that represents the user.
protected T	validateUsernameToken(Session session, UserNameIdentityToken token, UserTokenPolicy tokenPolicy, SignatureData tokenSignature) Validate a UserNameIdentityToken and return an identity Object that represents the user.

Methods inherited from class org.eclipse.milo.opcua.sdk.server.identity.AbstractIdentityValidator

decryptTokenData, validateIdentityToken, validateIssuedIdentityToken, validateX509Token

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractUsernameIdentityValidator

public AbstractUsernameIdentityValidator()

Method Detail

validateAnonymousToken

protected T validateAnonymousToken(Session session,
                                   AnonymousIdentityToken token,
                                   UserTokenPolicy tokenPolicy,
                                   SignatureData tokenSignature)
                            throws UaException

Description copied from class: AbstractIdentityValidator

Validate an AnonymousIdentityToken and return an identity Object that represents the user.

This Object should implement equality in such a way that a subsequent identity validation for the same user yields a comparable Object.

Overrides:

validateAnonymousToken in class AbstractIdentityValidator<T>

Parameters:

session - the Session the request is arriving on.

token - the AnonymousIdentityToken.

tokenPolicy - the UserTokenPolicy specified by the policyId in token.

tokenSignature - the SignatureData sent in the ActivateSessionRequest.

Returns:

an identity Object that represents the user.

Throws:

UaException - if the token is invalid, rejected, or user access is denied.

validateUsernameToken

protected T validateUsernameToken(Session session,
                                  UserNameIdentityToken token,
                                  UserTokenPolicy tokenPolicy,
                                  SignatureData tokenSignature)
                           throws UaException

Description copied from class: AbstractIdentityValidator

Validate a UserNameIdentityToken and return an identity Object that represents the user.

This Object should implement equality in such a way that a subsequent identity validation for the same user yields a comparable Object.

Overrides:

validateUsernameToken in class AbstractIdentityValidator<T>

Parameters:

session - the Session the request is arriving on.

token - the UserNameIdentityToken.

tokenPolicy - the UserTokenPolicy specified by the policyId in token.

tokenSignature - the SignatureData sent in the ActivateSessionRequest.

Returns:

an identity Object that represents the user.

Throws:

UaException - if the token is invalid, rejected, or user access is denied.

authenticateAnonymous

@Nullable
protected abstract T authenticateAnonymous(Session session)

Create and return an identity object for an anonymous user.

Parameters:

session - the Session being activated.

Returns:

an identity object of type T representig an anonymous user, or null if anonymous authentication is not allowed.

authenticateUsernamePassword

@Nullable
protected abstract T authenticateUsernamePassword(Session session,
                                                            String username,
                                                            String password)

Authenticate username with password, returning an identity object of type T if the authentication succeeded, or null if the authentication failed.

Parameters:

session - the Session being activated.

username - the username to authenticate.

password - the password to authenticate the user with.

Returns:

an identity object of type T if the authentication succeeded, or null if it failed.