*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.deployment
Interface MetadataSourceInterface

All Superinterfaces:

All Known Implementing Classes:

AbstractMetadataSource, OMRMetadataSource, URLMetadataSource

public interface MetadataSourceInterface

extends java.io.Serializable

Interface specifying methods used to deploy foundation services from a metadata source.

Since:

1.0

Method Summary

void	destroy() Destroys the metadata source.
String	getApplicationServiceDeployment() Gets the name of the application service deployment.
MdObjectStore	getMdObjectStore(boolean isOKToCreate) Gets the metadata object store.
String	getMetadata() Gets XML formatted metadata.
Set	getServiceDeploymentNames() Gets the set of service deployment names that are to be deployed.
boolean	isOKToDestroy() Determines whether or not it is OK for this source to be destroyed.
boolean	isServiceDeploymentDeployable(String applicationServiceDeployment) Determines whether or not the specified service deployment is deployable.
boolean	isServiceDeploymentDeployable(String applicationServiceDeployment, Tree serviceDeploymentGroup) Determines whether or not the specified application service deployment's service deployment group is deployable.
void	setApplicationServiceDeployment(String softwareComponentName) Sets the name of the application service deployment.
void	setIsOKToClose(boolean isOKToCloseConnection) Specifies whether or not it is OK for the service loader to close this connection once it no longer needs it.

Method Detail

getMetadata

public String getMetadata()
                   throws ServiceException

Gets XML formatted metadata.

Returns:

XML formatted metadata obtained from the metadata source.

Throws:

ServiceException - if unable to acquire metadata from the source.

isServiceDeploymentDeployable

public boolean isServiceDeploymentDeployable(String applicationServiceDeployment)

Determines whether or not the specified service deployment is deployable.

Parameters:

applicationServiceDeployment - An application's foundation services deployment which is represented using a metadata SoftwareComponent.

Returns:

true if it is OK to deploy this appliation's service deployment or false if it isn't.

isServiceDeploymentDeployable

public boolean isServiceDeploymentDeployable(String applicationServiceDeployment,
                                             Tree serviceDeploymentGroup)

Determines whether or not the specified application service deployment's service deployment group is deployable.

Parameters:

applicationServiceDeployment - An application's foundation services deployment which is represented using a metadata SoftwareComponent.

serviceDeploymentGroup - Service deployment group defined under the application's service deployment.

Returns:

true if it is OK to deploy this service deployment or false if it isn't.

getApplicationServiceDeployment

public String getApplicationServiceDeployment()

Gets the name of the application service deployment.

Returns:

Application's service deployment name.

setApplicationServiceDeployment

public void setApplicationServiceDeployment(String softwareComponentName)

Sets the name of the application service deployment.

Parameters:

softwareComponentName - An application's foundation services deployment which is represented using a metadata SoftwareComponent.

getServiceDeploymentNames

public Set getServiceDeploymentNames()

Gets the set of service deployment names that are to be deployed. A service deployment name corresponds to the metadata SoftwareComponent element's Name attribute.

If a set of service deployment names is not currently defined then a set will be lazily instantiated and returned with no elements.

Returns:

Set of String names of the service deployments that are to be deployed. Note that this set may not contain any elements, but it is guaranteed to be non-null.

getMdObjectStore

public MdObjectStore getMdObjectStore(boolean isOKToCreate)

Gets the metadata object store.

Parameters:

isOKToCreate - true if it is OK to create a metadata object store if one is not currently defined.

Returns:

Metadata object store or null if a metadata object store is not defined.

setIsOKToClose

public void setIsOKToClose(boolean isOKToCloseConnection)

Specifies whether or not it is OK for the service loader to close this connection once it no longer needs it.

Parameters:

isOKToCloseConnection - true if it is OK for the service loader to close and dispose of this connection once it no longer needs it or false if this connection is to be closed somewhere else when its no longer needed.

isOKToDestroy

public boolean isOKToDestroy()

Determines whether or not it is OK for this source to be destroyed.

Returns:

true if it is OK to close and dispose of this connection once it no longer needs it or false if this connection is to be closed somewhere else when its no longer needed.

destroy

public void destroy()

Destroys the metadata source. This method should be called when this metadata source is no longer needed to release any resources it may be holding.

*** This API provides Binary Compatibility only, not Source Compatibility ***