com.vmware.vapi.security

Class AuthenticationFilter

java.lang.Object

com.vmware.vapi.core.DecoratorApiProvider

com.vmware.vapi.security.AuthenticationFilter

All Implemented Interfaces:

ApiProvider

public final class AuthenticationFilter
extends DecoratorApiProvider

This class acts as a decorator to the actual provider. It enforces the authentication rules defined in the authentication config file.

Field Summary

Fields inherited from class com.vmware.vapi.core.DecoratorApiProvider

decoratedProvider

Constructor Summary

Constructors

Constructor and Description
AuthenticationFilter(ApiProvider decoratedProvider, AuthenticationConfig authnConfig, List<AuthenticationHandler> authnHandlers)

Method Summary

Modifier and Type	Method and Description
static Set<String>	getImplicitlyAnonymousOperations()
void	invoke(String serviceId, String operationId, DataValue input, ExecutionContext ctx, AsyncHandle<MethodResult> asyncHandle) Invokes the specified operation using the provided input and execution context.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationFilter

public AuthenticationFilter(ApiProvider decoratedProvider,
                            AuthenticationConfig authnConfig,
                            List<AuthenticationHandler> authnHandlers)

Parameters:

decoratedProvider - the provider that is decorated with this authentication filter. cannot be null.

authnConfig - the authentication configuration. cannot be null.

authnHandlers - a list of the authentication handlers that will be executed during authentication events. cannot be null.

Method Detail

invoke

public void invoke(String serviceId,
                   String operationId,
                   DataValue input,
                   ExecutionContext ctx,
                   AsyncHandle<MethodResult> asyncHandle)

Description copied from interface: ApiProvider

Invokes the specified operation using the provided input and execution context.

Target method is identified by serviceId and operationId.

Specified by:

invoke in interface ApiProvider

Overrides:

invoke in class DecoratorApiProvider

Parameters:

serviceId - identifier of the target service

operationId - identifier of the target operation

input - operation input parameters

ctx - execution context for the invocation

asyncHandle - handle used to asynchronously "return" the result or error of the invocation

getImplicitlyAnonymousOperations

public static Set<String> getImplicitlyAnonymousOperations()

Returns:

the fully-qualified names of operations which the vapi-runtime deems anonymous without the secure-by-default requirement of having them listed explicitly as anonymous.