oracle.owb.runtime
Interface RuntimePlatformService

public interface RuntimePlatformService

An interface to access the Runtime Platform.

Method Summary

void	closeConnection() Close the wrapped Runtime Platform Schema Connection.
DeploymentSpecification	createDeploymentSpecification(RuntimeObjectList runtimeObjectList) Create a DeploymentSpecification for the Components held in the RuntimeObjectList.
RuntimeObjectList	createRuntimeObjectList() Construct an empty RuntimeObjectList.
int[]	getDeploymentActions(Component component, Location location) Return all the deployment operations that can be specified for the given Component.
boolean	isLocationNameRegistered(java.lang.String locationName) Is there a Location registered in the Runtime Platform Schema with the provided name.
boolean	isLocationUOIDRegistered(java.lang.String locationUOID) Is there a Location registered in the Runtime Platform Schema with the provided UOID.
void	registerLocation(java.lang.String locationName, java.lang.String locationTypeName, java.lang.String locationTypeVersion, java.lang.String locationUoid, boolean isDeploymentTarget, java.lang.String[] paramNames, java.lang.String[] paramValues) Register a Location in the Runtime Platform Schema.
void	runDeploymentSpecification(java.io.Reader specXML) Perform a Deployment of the provided Deployment Specification as read from the Reader.

Method Detail

createRuntimeObjectList

public RuntimeObjectList createRuntimeObjectList()

Construct an empty RuntimeObjectList.

Returns:

an empty RuntimeObjectList

createDeploymentSpecification

public DeploymentSpecification createDeploymentSpecification(RuntimeObjectList runtimeObjectList)
                                                      throws RuntimePlatformException

Create a DeploymentSpecification for the Components held in the RuntimeObjectList.

Parameters:

runtimeObjectList - the list from which to build the DeploymentSpecification

Returns:

a DeploymentSpecification

Throws:

RuntimePlatformException

getDeploymentActions

public int[] getDeploymentActions(Component component,
Location location)
                           throws RuntimePlatformException

Return all the deployment operations that can be specified for the given Component.

Parameters:

component - the Component to be processed

location - the Location Target for the associated Component

Returns:

an Array of possible deployment actions

Throws:

RuntimePlatformException

closeConnection

public void closeConnection()
                     throws RuntimePlatformException

Close the wrapped Runtime Platform Schema Connection.

Throws:

RuntimePlatformException

registerLocation

public void registerLocation(java.lang.String locationName,
                             java.lang.String locationTypeName,
                             java.lang.String locationTypeVersion,
                             java.lang.String locationUoid,
                             boolean isDeploymentTarget,
                             java.lang.String[] paramNames,
                             java.lang.String[] paramValues)
                      throws RuntimePlatformException

Register a Location in the Runtime Platform Schema. Note, the paramNames and paramValues Arrays represent ordered pairs of parameter data.

Parameters:

locationName - the name of the Location to be registered

locationTypeName - the type of the Location to be registered

locationTypeVersion - the version of the Location to be registered

locationUoid - the UOID of the Location to be registered

isDeploymentTarget - is the Location to be registered as a Deployment Target

paramNames - an array of parameter names to be registered for the Location.

paramValues - an array of parameter values to be registered for the Location.

Throws:

RuntimePlatformException

isLocationUOIDRegistered

public boolean isLocationUOIDRegistered(java.lang.String locationUOID)
                                 throws RuntimePlatformException

Is there a Location registered in the Runtime Platform Schema with the provided UOID.

Parameters:

locationUOID - the location UOID to be used in the test

Returns:

is the Location UOID regstered

Throws:

RuntimePlatformException

isLocationNameRegistered

public boolean isLocationNameRegistered(java.lang.String locationName)
                                 throws RuntimePlatformException

Is there a Location registered in the Runtime Platform Schema with the provided name.

Parameters:

locationName - the location name to be used in the test

Returns:

is the Location name regstered

Throws:

RuntimePlatformException

runDeploymentSpecification

public void runDeploymentSpecification(java.io.Reader specXML)
                                throws RuntimePlatformException

Perform a Deployment of the provided Deployment Specification as read from the Reader.

Parameters:

specXML - a Reader from which to read a Deployment Specifcation XML Stream

Throws:

RuntimePlatformException