com.sap.cloud.security.test

Class ApplicationServerOptions

java.lang.Object

com.sap.cloud.security.test.ApplicationServerOptions

public class ApplicationServerOptions
extends Object

This class is used to configure the application server to serve test servlets inside the SecurityTestRule.

Method Summary

Modifier and Type	Method and Description
static ApplicationServerOptions	forService(Service service) Creates an instance of ApplicationServerOptions.
static ApplicationServerOptions	forXsuaaService(String appId, String clientId) Creates an instance of ApplicationServerOptions.
int	getPort()
TokenAuthenticator	getTokenAuthenticator()
ApplicationServerOptions	usePort(int port) Use this method to configure a custom port on which the application server will listen to.
ApplicationServerOptions	useTokenAuthenticator(TokenAuthenticator tokenAuthenticator) Use this method to configure a custom TokenAuthenticator that will be used in the application server to authenticate the user via tokens retrieved in the authorization header.

Methods inherited from class java.lang.Object

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

Method Detail

forXsuaaService

public static ApplicationServerOptions forXsuaaService(String appId,
                                                       String clientId)

Creates an instance of ApplicationServerOptions. Overwrites the application id that is required by the XsuaaAudienceValidator.

Parameters:

appId - the xsuaa application name e.g. myapp!t123.

clientId - the xsuaa client id of the application

Returns:

the application server options.

forService

public static ApplicationServerOptions forService(Service service)

Creates an instance of ApplicationServerOptions.

Parameters:

service - the identity service

Returns:

the application server options.

useTokenAuthenticator

public ApplicationServerOptions useTokenAuthenticator(TokenAuthenticator tokenAuthenticator)

Use this method to configure a custom TokenAuthenticator that will be used in the application server to authenticate the user via tokens retrieved in the authorization header.

Parameters:

tokenAuthenticator - the custom TokenAuthenticator.

Returns:

the new configuration object.

usePort

public ApplicationServerOptions usePort(int port)

Use this method to configure a custom port on which the application server will listen to. If not set, the servlet server will use on a free random port.

Parameters:

port - the custom port.

Returns:

the new configuration object.

getTokenAuthenticator

public TokenAuthenticator getTokenAuthenticator()

getPort

public int getPort()