SecurityTest (java-security-test 2.7.2 API)

java.lang.Object
- com.sap.cloud.security.test.SecurityTest

public class SecurityTest
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.eclipse.jetty.server.Server`	`applicationServer`
`protected ApplicationServerOptions`	`applicationServerOptions`
`protected List<org.eclipse.jetty.servlet.FilterHolder>`	`applicationServletFilters`
`protected Map<String,org.eclipse.jetty.servlet.ServletHolder>`	`applicationServletsByPath`
`protected String`	`clientId`
`static String`	`DEFAULT_APP_ID`
`static String`	`DEFAULT_CLIENT_ID`
`static String`	`DEFAULT_DOMAIN`
`protected String`	`jwksUrl`
`protected RSAKeys`	`keys`
`protected static String`	`LOCALHOST_PATTERN`
`protected static org.slf4j.Logger`	`LOGGER`
`protected Service`	`service`
`protected boolean`	`useApplicationServer`
`protected com.github.tomakehurst.wiremock.WireMockServer`	`wireMockServer`

Constructor Summary

Constructors
Constructor and Description

SecurityTest(Service service)

Constructors
Constructor and Description
`SecurityTest(Service service)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SecurityTest`	`addApplicationServlet(Class<? extends javax.servlet.Servlet> servletClass, String path)` Adds a servlet to the servlet server.
`SecurityTest`	`addApplicationServlet(org.eclipse.jetty.servlet.ServletHolder servletHolder, String path)` Adds a servlet to the servlet server.
`SecurityTest`	`addApplicationServletFilter(Class<? extends javax.servlet.Filter> filterClass)` Adds a filter to the servlet server.
`Token`	`createToken()` Creates a very basic token on base of the preconfigured Jwt token generator.
`String`	`getApplicationServerUri()` Returns the URI of the embedded jetty server or null if not specified.
`JwtGenerator`	`getPreconfiguredJwtGenerator()` Note: the JwtGenerator is fully configured as part of `setup()` method.
`com.github.tomakehurst.wiremock.WireMockServer`	`getWireMockServer()` Allows to stub further endpoints of the identity service.
`SecurityTest`	`setKeys(String publicKeyPath, String privateKeyPath)` Overwrites the private/public key pair to be used.
`SecurityTest`	`setPort(int port)` Overwrites the port on which the identity service mock server runs (WireMock).
`void`	`setup()` Starts the Jetty application web server and the WireMock OAuthServer if not running.
`void`	`tearDown()` Shuts down Jetty application web server and WireMock stub.
`SecurityTest`	`useApplicationServer()` Specifies an embedded jetty as servlet server.
`SecurityTest`	`useApplicationServer(ApplicationServerOptions applicationServerOptions)` Specifies an embedded jetty as servlet server.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOGGER
```
protected static final org.slf4j.Logger LOGGER
```
  - DEFAULT_APP_ID
```
public static final String DEFAULT_APP_ID
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CLIENT_ID
```
public static final String DEFAULT_CLIENT_ID
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DOMAIN
```
public static final String DEFAULT_DOMAIN
```
    See Also:
    
    Constant Field Values
  - LOCALHOST_PATTERN
```
protected static final String LOCALHOST_PATTERN
```
    See Also:
    
    Constant Field Values
  - applicationServletsByPath
```
protected final Map<String,org.eclipse.jetty.servlet.ServletHolder> applicationServletsByPath
```
  - applicationServletFilters
```
protected final List<org.eclipse.jetty.servlet.FilterHolder> applicationServletFilters
```
  - applicationServer
```
protected org.eclipse.jetty.server.Server applicationServer
```
  - applicationServerOptions
```
protected ApplicationServerOptions applicationServerOptions
```
  - useApplicationServer
```
protected boolean useApplicationServer
```
  - wireMockServer
```
protected com.github.tomakehurst.wiremock.WireMockServer wireMockServer
```
  - keys
```
protected RSAKeys keys
```
  - service
```
protected Service service
```
  - clientId
```
protected String clientId
```
  - jwksUrl
```
protected String jwksUrl
```
- Constructor Detail
  - SecurityTest
```
public SecurityTest(Service service)
```
- Method Detail
  - useApplicationServer
```
public SecurityTest useApplicationServer()
```
    Specifies an embedded jetty as servlet server. It needs to be configured before the setup() method. The application server will be started with default options for the given Service, see ApplicationServerOptions.forService(Service) for details. By default the servlet server will listen on a free random port. Use SecurityTestRule.useApplicationServer(ApplicationServerOptions) to overwrite default settings. Use getApplicationServerUri() to obtain the actual port used at runtime.
    
    Returns:
    
    the rule itself.
  - useApplicationServer
```
public SecurityTest useApplicationServer(ApplicationServerOptions applicationServerOptions)
```
    Specifies an embedded jetty as servlet server. It needs to be configured before the setup() method. Use ApplicationServerOptions.forService(Service) to obtain a configuration object that can be customized. See ApplicationServerOptions for details.
    
    Parameters:
    
    applicationServerOptions - custom options to configure the application server.
    
    Returns:
    
    the rule itself.
  - addApplicationServlet
```
public SecurityTest addApplicationServlet(Class<? extends javax.servlet.Servlet> servletClass,
                                          String path)
```
    Adds a servlet to the servlet server. Only has an effect when used in conjunction with useApplicationServer.
    
    Parameters:
    
    servletClass - the servlet class that should be served.
    
    path - the path on which the servlet should be served, e.g. "/*".
    
    Returns:
    
    the rule itself.
  - addApplicationServlet
```
public SecurityTest addApplicationServlet(org.eclipse.jetty.servlet.ServletHolder servletHolder,
                                          String path)
```
    Adds a servlet to the servlet server. Only has an effect when used in conjunction with useApplicationServer.
    
    Parameters:
    
    servletHolder - the servlet inside a ServletHolder that should be served.
    
    path - the path on which the servlet should be served, e.g. "/*".
    
    Returns:
    
    the rule itself.
  - addApplicationServletFilter
```
public SecurityTest addApplicationServletFilter(Class<? extends javax.servlet.Filter> filterClass)
```
    Adds a filter to the servlet server. Only has an effect when used in conjunction with useApplicationServer.
    
    Parameters:
    
    filterClass - the filter class that should intercept with incoming requests.
    
    Returns:
    
    the rule itself.
  - setPort
```
public SecurityTest setPort(int port)
```
    Overwrites the port on which the identity service mock server runs (WireMock). It needs to be configured before the setup() method. If the port is not specified or is set to 0, a free random port is chosen.
    
    Parameters:
    
    port - the port on which the wire mock service is started.
    
    Returns:
    
    the rule itself.
  - setKeys
```
public SecurityTest setKeys(String publicKeyPath,
                            String privateKeyPath)
```
    Overwrites the private/public key pair to be used. The private key is used to sign the jwt token. The public key is provided by jwks endpoint (on behalf of WireMock). Checked exceptions are caught and rethrown as runtime exceptions for test convenience.
    
    Parameters:
    
    publicKeyPath - resource path to public key file.
    
    privateKeyPath - resource path to private key file.
    
    Returns:
    
    the rule itself.
  - getPreconfiguredJwtGenerator
```
public JwtGenerator getPreconfiguredJwtGenerator()
```
    Note: the JwtGenerator is fully configured as part of setup() method.
    
    Returns:
    
    the preconfigured Jwt token generator
  - createToken
```
public Token createToken()
```
    Creates a very basic token on base of the preconfigured Jwt token generator. In case you like to specify further token claims, you can make use of getPreconfiguredJwtGenerator()
    
    Returns:
    
    the token.
  - getWireMockServer
```
public com.github.tomakehurst.wiremock.WireMockServer getWireMockServer()
```
    Allows to stub further endpoints of the identity service. Returns null if the server is not yet initialized as part of setup() method. You can find a detailed explanation on how to configure wire mock here: http://wiremock.org/docs/getting-started/
    
    Returns:
    
    an instance of WireMockServer
  - getApplicationServerUri
```
@Nullable
public String getApplicationServerUri()
```
    Returns the URI of the embedded jetty server or null if not specified.
    
    Returns:
    
    uri of the application server
  - setup
```
public void setup()
           throws Exception
```
    Starts the Jetty application web server and the WireMock OAuthServer if not running. Otherwise it resets WireMock and configures the stubs. Additionally it generates the JWK URL. Should be called before each test. Starts the server only, if it was not yet started.
    
    Throws:
    
    IOException - if the stub cannot be initialized
    
    Exception
  - tearDown
```
public void tearDown()
```
    Shuts down Jetty application web server and WireMock stub. Should be called when all tests are executed to avoid unwanted side-effects.

Class SecurityTest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

DEFAULT_APP_ID

DEFAULT_CLIENT_ID

DEFAULT_DOMAIN

LOCALHOST_PATTERN

applicationServletsByPath

applicationServletFilters

applicationServer

applicationServerOptions

useApplicationServer

wireMockServer

keys

service

clientId

jwksUrl

Constructor Detail

SecurityTest

Method Detail

useApplicationServer

useApplicationServer

addApplicationServlet

addApplicationServlet

addApplicationServletFilter

setPort

setKeys

getPreconfiguredJwtGenerator

createToken

getWireMockServer

getApplicationServerUri

setup

tearDown