MyContainer (MyContainer Runtime 1.0.0 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.gcube.common.mycontainer.MyContainer

```
public class MyContainer
extends Object
```
An embedded gCore container for integration testing.
The container is partially embedded, in that it requires an installation on the local file system. It can be configured with the following properties:
- Utils.CONTAINER_LOCATION_PROPERTY: the path to the local installation of the container. For test automation, the container installation should be treated as a test resource and its path ought to be relative to the working directory..
- Utils.PORT_PROPERTY: the port at which the container will be running. The default port is Utils.DEFAULT_PORT.
- Utils.STARTUP_TIMEOUT_PROPERTY: the time in millisecond within which a started container must reach a ready or certified state (depending on weather services have been deployed in it). The default startup timeout is Utils.DEFAULT_STARTUP_TIMEOUT.
Note: since the container relies on statics, starting it and stopping it multiple times within the same runtime may have undesirable effects. For test isolation and reproducibility, the container is best started once per JVM, typically for the execution of a single test suite. IDEs typically fork JVMs per test suites, but build systems such as Ant or Maven may have to be explicitly configured for this.
Author:

Fabio Simeoni

Constructor Summary

Constructors
Constructor and Description
`MyContainer(Gar... gars)` Creates an instance configured with: the properties found in a `Utils.PROPERTY_FILE` zero or more `Gar`s Note that:
`MyContainer(Properties properties, boolean merge, Gar... gars)` An overload of `MyContainer(Properties, Gar...)` where the configuration properties passed in input can augment or override those in a `Utils.PROPERTY_FILE`.
`MyContainer(Properties properties, Gar... gars)` Creates an instance configured with: given properties zero or more `Gar`s Note that the Gars are deployed when the container is started.
`MyContainer(String location, Gar... gars)` Creates an instance configured: a given location default properties zero or more `Gar`s Note that the Gars are deployed when the container is started.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`cleanState()`
`File`	`configLocation()` Returns the container's configuration folder.
`File`	`deploymentsLocation()` Returns the container's deployment folders.
`org.apache.axis.message.addressing.EndpointReferenceType`	`endpoint(String name)` Returns the endpoint of a port-type of a service running in the container on the default port.
`org.apache.axis.message.addressing.EndpointReferenceType`	`endpoint(String name, int port)` Returns the endpoint of a port-type of a service running in the container on a given port.
`boolean`	`isRunning()`
`File`	`libLocation()` Returns the container's library folder.
`File`	`location()` Returns the location of the container's installation.
`<T> T`	`portType(String name, Class<T> clazz)` Returns the implementation of a port-type of a service deployed in the container with `application` scope.
`void`	`start()` Starts the container, deploying the GARs with which it was configured.
`void`	`stop()` Stops the container.
`File`	`storageLocation()` Returns the container's storage folder.

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

- Constructor Detail
  - MyContainer
```
public MyContainer(Gar... gars)
            throws IllegalStateException,
                   IllegalArgumentException
```
    Creates an instance configured with:
    - the properties found in a Utils.PROPERTY_FILE
    - zero or more Gars
    Note that:
    - the search for the Utils.PROPERTY_FILE is delegated to Utils.findContainerProperties()
    - the Gars are deployed when the container is started. Gars which are already deployed in the container are re-deployed only if they have changed since. Changes are computed based on the last modification date of their assets.
    Parameters:
    gars - the Gars
    
    Throws:
    
    IllegalStateException - if the Utils.PROPERTY_FILE cannot be found
    
    IllegalArgumentException - if the Utils.PROPERTY_FILE is found but contains invalid properties
  - MyContainer
```
public MyContainer(String location,
           Gar... gars)
            throws IllegalStateException,
                   IllegalArgumentException
```
    Creates an instance configured:
    - a given location
    - default properties
    - zero or more Gars
    Note that the Gars are deployed when the container is started. Gars which are already deployed in the container are re-deployed only if they have changed since. Changes are computed based on the last modification date of their assets.

Parameters:: location - the location of the container's installation.; gars - the Gars
Throws:: IllegalStateException - if the Utils.PROPERTY_FILE cannot be found; IllegalArgumentException - if the Utils.PROPERTY_FILE is found but contains invalid properties

MyContainer
```
public MyContainer(Properties properties,
           Gar... gars)
            throws IllegalArgumentException
```
Creates an instance configured with:
- given properties
- zero or more Gars
Note that the Gars are deployed when the container is started. Gars which are already deployed in the container are re-deployed only if they have changed since. Changes are computed based on the last modification date of their assets.

Parameters:: properties - the properties; gars - the Gars
Throws:: IllegalArgumentException - if the the properties are invalid.

MyContainer
```
public MyContainer(Properties properties,
           boolean merge,
           Gar... gars)
            throws IllegalArgumentException,
                   IllegalStateException
```
An overload of MyContainer(Properties, Gar...) where the configuration properties passed in input can augment or override those in a Utils.PROPERTY_FILE.

Parameters:
properties - the properties
merge - true if the properties are to augment or override those in a Utils.PROPERTY_FILE. The discovery of Utils.PROPERTY_FILE is delegated to Utils.findContainerProperties()
gars - the Gars.

Throws:

IllegalArgumentException - if the properties are invalid

IllegalStateException - if the properties cannot be merged because Utils.PROPERTY_FILE cannot be found

Method Detail
- location
```
public File location()
```
  Returns the location of the container's installation.
  
  Returns:
  the location
- storageLocation
```
public File storageLocation()
```
  Returns the container's storage folder.
  
  Returns:
  the folder
- configLocation
```
public File configLocation()
```
  Returns the container's configuration folder.
  
  Returns:
  the folder
- deploymentsLocation
```
public File deploymentsLocation()
```
  Returns the container's deployment folders.
  
  Returns:
  the folder
- libLocation
```
public File libLocation()
```
  Returns the container's library folder.
  
  Returns:
  the folder
- portType
```
public <T> T portType(String name,
             Class<T> clazz)
           throws IllegalStateException
```
  Returns the implementation of a port-type of a service deployed in the container with application scope.
  
  Type Parameters:
  T - the type of the implementation
  Parameters:
  name - the name of the port-type
  clazz - the runtime representation of the implementation type
  
  Returns:
  the implementation, or null if no implementation was found
  
  Throws:
  
  IllegalStateException - if the container is not running or a service with a port-type with the given name is not running in the container
  
  ClassCastException - if the port-type implementation cannot be cast to the given type
- endpoint
```
public org.apache.axis.message.addressing.EndpointReferenceType endpoint(String name)
                                                                  throws IllegalStateException
```
  Returns the endpoint of a port-type of a service running in the container on the default port.
  
  Parameters:
  name - the name of the port-type
  
  Returns:
  the port-type
  
  Throws:
  
  IllegalStateException - if the container is not running or a service with a port-type with the given name is not running in the container
- endpoint
```
public org.apache.axis.message.addressing.EndpointReferenceType endpoint(String name,
                                                                int port)
                                                                  throws IllegalStateException
```
  Returns the endpoint of a port-type of a service running in the container on a given port.
  
  Parameters:
  name - the name of the port-type
  port - the target port
  
  Returns:
  the port-type
  
  Throws:
  
  IllegalStateException - if the container is not running or a service with a port-type with the given name is not running in the container
- isRunning
```
public boolean isRunning()
```
- start
```
public void start()
```
  Starts the container, deploying the GARs with which it was configured.
- stop
```
public void stop()
```
  Stops the container.
- cleanState
```
public void cleanState()
```

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2012. All Rights Reserved.