S3MockApplication (S3Mock - Server 2.1.16 API)

java.lang.Object
- com.adobe.testing.s3mock.S3MockApplication

@Configuration
 @EnableAutoConfiguration(exclude=org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration.class,
                         excludeName="org.springframework.boot.actuate.autoconfigure.security.servlet.ManagementWebSecurityAutoConfiguration")
 @ComponentScan
public class S3MockApplication
extends Object

File Store Application that mocks Amazon S3.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_HTTP_PORT`
`static int`	`DEFAULT_HTTPS_PORT`
`static String`	`PROP_HTTP_PORT` Property name for passing the HTTP port to use.
`static String`	`PROP_HTTPS_PORT` Property name for passing the HTTPS port to use.
`static String`	`PROP_INITIAL_BUCKETS` Property name for passing a comma separated list of buckets that are to be created at startup.
`static String`	`PROP_ROOT_DIRECTORY` Property name for passing a root directory to use.
`static String`	`PROP_SECURE_CONNECTION` Property name for using either HTTPS or HTTP connections.
`static String`	`PROP_SILENT` Property name for enabling the silent mode with logging set at WARN and without banner.
`static int`	`RANDOM_PORT`

Constructor Summary

Constructors
Constructor and Description

S3MockApplication()

Constructors
Constructor and Description
`S3MockApplication()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getHttpPort()` Gets the Http server port.
`int`	`getPort()` Gets the Https server port.
`static void`	`main(String[] args)` Main Class that starts the server using `start(String...)`.
`void`	`registerKMSKeyRef(String keyRef)` Registers a valid KMS key reference on the mock server.
`static S3MockApplication`	`start(Map<String,Object> properties, String... args)` Starts the server.
`static S3MockApplication`	`start(String... args)` Starts the server.
`void`	`stop()` Stops the server.

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

- Field Detail
  - DEFAULT_HTTPS_PORT
```
public static final int DEFAULT_HTTPS_PORT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HTTP_PORT
```
public static final int DEFAULT_HTTP_PORT
```
    See Also:
    
    Constant Field Values
  - RANDOM_PORT
```
public static final int RANDOM_PORT
```
    See Also:
    
    Constant Field Values
  - PROP_INITIAL_BUCKETS
```
public static final String PROP_INITIAL_BUCKETS
```
    Property name for passing a comma separated list of buckets that are to be created at startup.
    
    See Also:
    
    Constant Field Values
  - PROP_ROOT_DIRECTORY
```
public static final String PROP_ROOT_DIRECTORY
```
    Property name for passing a root directory to use. If omitted a default temp-dir will be used.
    
    See Also:
    
    Constant Field Values
  - PROP_HTTPS_PORT
```
public static final String PROP_HTTPS_PORT
```
    Property name for passing the HTTPS port to use. Defaults to 9191. If set to 0, a random port will be chosen.
    
    See Also:
    
    Constant Field Values
  - PROP_HTTP_PORT
```
public static final String PROP_HTTP_PORT
```
    Property name for passing the HTTP port to use. Defaults to 9090. If set to 0, a random port will be chosen.
    
    See Also:
    
    Constant Field Values
  - PROP_SECURE_CONNECTION
```
public static final String PROP_SECURE_CONNECTION
```
    Property name for using either HTTPS or HTTP connections.
    
    See Also:
    
    Constant Field Values
  - PROP_SILENT
```
public static final String PROP_SILENT
```
    Property name for enabling the silent mode with logging set at WARN and without banner.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - S3MockApplication
```
public S3MockApplication()
```
- Method Detail
  - main
```
public static void main(String[] args)
```
    Main Class that starts the server using start(String...).
    
    Parameters:
    
    args - Default command args.
  - start
```
public static S3MockApplication start(String... args)
```
    Starts the server.
    
    Parameters:
    
    args - in program args format, e.g. "--server.port=0".
    
    Returns:
    
    the S3MockApplication
  - start
```
public static S3MockApplication start(Map<String,Object> properties,
                                      String... args)
```
    Starts the server.
    
    Parameters:
    
    properties - properties to pass to the application in key-value format.
    
    args - in program args format, e.g. "--server.port=0".
    
    Returns:
    
    the S3MockApplication
  - stop
```
public void stop()
```
    Stops the server.
  - getPort
```
public int getPort()
```
    Gets the Https server port.
    
    Returns:
    
    Https server port.
  - getHttpPort
```
public int getHttpPort()
```
    Gets the Http server port.
    
    Returns:
    
    Http server port.
  - registerKMSKeyRef
```
public void registerKMSKeyRef(String keyRef)
```
    Registers a valid KMS key reference on the mock server.
    
    Parameters:
    
    keyRef - A KMS Key Reference

Class S3MockApplication

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HTTPS_PORT

DEFAULT_HTTP_PORT

RANDOM_PORT

PROP_INITIAL_BUCKETS

PROP_ROOT_DIRECTORY

PROP_HTTPS_PORT

PROP_HTTP_PORT

PROP_SECURE_CONNECTION

PROP_SILENT

Constructor Detail

S3MockApplication

Method Detail

main

start

start

stop

getPort

getHttpPort

registerKMSKeyRef