|
Foundation |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.sas.services.deployment.ServiceDeployments
public class ServiceDeployments
Utility class that represents foundation service deployments which are represented as a
SoftwareComponent
element in an open metadata repository.
Utilities are provided for the following operations.
Method Summary | |
---|---|
static void |
deleteDeployment(com.sas.metadata.remote.SoftwareComponent softwareComponent)
Deletes a foundation services deployment. |
static void |
deleteGroup(com.sas.metadata.remote.Tree tree,
boolean isValidatingServiceDependencies)
Deletes a foundation services deployment group. |
static void |
deleteRegistry(com.sas.metadata.remote.DeployedComponent deployedComponent)
Deletes a foundation service registry. |
static void |
deleteService(com.sas.metadata.remote.ServiceComponent serviceComponent,
boolean isValidatingDependentServices)
Deletes a foundation service. |
static java.lang.String[] |
getNames(com.sas.meta.SASOMI.IOMI iomi,
java.lang.String repositoryID)
Gets the names of all foundation service deployments defined in the specified metadata repository. |
static com.sas.metadata.remote.ServiceComponent |
getServiceComponent(com.sas.metadata.remote.MdStore mdStore,
java.lang.String repositoryID,
java.lang.String softwareComponentName,
java.lang.String groupName,
java.lang.String serviceComponentName)
Gets the ServiceComponent from the specified open metadata repository. |
static com.sas.metadata.remote.SoftwareComponent |
getServiceDeployment(com.sas.metadata.remote.MdStore mdStore,
java.lang.String repositoryID,
java.lang.String serviceDeploymentName)
Gets the SoftwareComponent for the specified foundation services deployment from
the SAS metadata repository. |
static com.sas.metadata.remote.SoftwareComponent |
getServiceDeploymentForID(com.sas.metadata.remote.MdStore mdStore,
java.lang.String repositoryID,
java.lang.String serviceDeploymentID)
Gets the SoftwareComponent for the specified foundation services deployment from
the SAS metadata repository for the specified FQID. |
static java.util.List<com.sas.metadata.remote.SoftwareComponent> |
getServiceDeployments(com.sas.metadata.remote.MdStore mdStore,
java.lang.String repositoryID,
java.util.Set<java.lang.String> serviceDeploymentsToFind)
Gets SoftwareComponent elements from the specified open metadata repository. |
static java.util.List<com.sas.metadata.remote.SoftwareComponent> |
getServiceDeploymentsUsingID(com.sas.metadata.remote.MdStore mdStore,
java.lang.String repositoryID,
java.util.Set<java.lang.String> serviceDeploymentIDsToFind)
Gets SoftwareComponent elements from the specified open metadata repository. |
static java.util.Set<com.sas.metadata.remote.ServiceComponent> |
getServices(com.sas.metadata.remote.SoftwareComponent softwareComponent)
Gets ServiceComponent elements that are defined within the specified
SoftwareComponent . |
static java.util.Set<com.sas.metadata.remote.ServiceComponent> |
getServices2(com.sas.metadata.remote.SoftwareComponent softwareComponent)
Gets ServiceComponent elements that are defined within the specified
SoftwareComponent . |
static com.sas.metadata.remote.SoftwareComponent |
getSoftwareComponent(com.sas.metadata.remote.Root root)
Gets the SoftwareComponent element that parents the metadata hierarchy in which
this specified root element exists. |
static com.sas.metadata.remote.SoftwareComponent |
getSoftwareComponentForGroup(com.sas.metadata.remote.Tree serviceDeploymentGroup)
Gets the SoftwareComponent element that parents the metadata hierarchy in which
this specified root element exists. |
static void |
verifyNoDependentServices(java.util.List<com.sas.metadata.remote.Tree> trees)
Determines whether or not its OK to delete all services that are defined within the specified group. |
Method Detail |
---|
public static final void deleteDeployment(com.sas.metadata.remote.SoftwareComponent softwareComponent) throws ServiceException, java.lang.IllegalArgumentException
softwareComponent
- Foundation services deployment that is to be deleted.
ServiceException
- if an exception occurred while deleting the deployment.
java.lang.IllegalArgumentException
- if an invalid parameter is specified.public static final void deleteGroup(com.sas.metadata.remote.Tree tree, boolean isValidatingServiceDependencies) throws ServiceException, DependentServicesException, java.lang.IllegalArgumentException
tree
- Foundation services deployment group that is to be deleted.isValidatingServiceDependencies
- true
if the service should not be deleted
if there are any services which use it or false
if the service should
be deleted without regard to it being used by any other services.
ServiceException
- if an exception occurred while deleting the group.
DependentServicesException
- if unable to delete the group because a service depends
upon one of the services that was to be deleted.
java.lang.IllegalArgumentException
- if an invalid parameter is specified.public static final void deleteService(com.sas.metadata.remote.ServiceComponent serviceComponent, boolean isValidatingDependentServices) throws DependentServicesException, ServiceException, java.lang.IllegalArgumentException
serviceComponent
- Foundation service that is to be deleted.isValidatingDependentServices
- true
if a check should occur to ensure that
a service is not being deleted which is required by another service.
DependentServicesException
- if the request to delete the service was denied because
another service depends upon the service being deleted.
ServiceException
- if an exception occurred while deleting the service.
java.lang.IllegalArgumentException
- if an invalid parameter is specified.public static final void deleteRegistry(com.sas.metadata.remote.DeployedComponent deployedComponent) throws ServiceException, java.lang.IllegalArgumentException
deployedComponent
- Service registry that is to be deleted.
ServiceException
- if an exception occurred while deleting the registry.
java.lang.IllegalArgumentException
- if an invalid parameter is specified.public static final void verifyNoDependentServices(java.util.List<com.sas.metadata.remote.Tree> trees) throws DependentServicesException
trees
- Groups containing the services that are to be deleted.
DependentServicesException
- if deletion of the specified service deployment groups
would result in a service that is notpublic static final com.sas.metadata.remote.SoftwareComponent getSoftwareComponent(com.sas.metadata.remote.Root root) throws java.lang.IllegalArgumentException
SoftwareComponent
element that parents the metadata hierarchy in which
this specified root element exists.
root
- Metadata object for which we want to determine the SoftwareComponent
that roots its metadata hierarchy.
SoftwareComponent
element that parents the metadata hierarchy in
which this specified root element exists. A null
is returned if a
SoftwareComponent
is undefined.
java.lang.IllegalArgumentException
- if a null
parameter is specified.public static final com.sas.metadata.remote.SoftwareComponent getSoftwareComponentForGroup(com.sas.metadata.remote.Tree serviceDeploymentGroup) throws java.lang.IllegalArgumentException
SoftwareComponent
element that parents the metadata hierarchy in which
this specified root element exists.
serviceDeploymentGroup
- Metadata object for which we want to determine the
SoftwareComponent
that roots its metadata hierarchy.
SoftwareComponent
element that parents the metadata hierarchy in
which this specified root element exists. A null
is returned if a
SoftwareComponent
is undefined.
java.lang.IllegalArgumentException
- if a null
parameter is specified.public static final java.util.Set<com.sas.metadata.remote.ServiceComponent> getServices(com.sas.metadata.remote.SoftwareComponent softwareComponent)
ServiceComponent
elements that are defined within the specified
SoftwareComponent
.
softwareComponent
-
ServiceComponent
. An empty
list is returned in the event that no ServiceComponent
elements were
found.public static final java.util.Set<com.sas.metadata.remote.ServiceComponent> getServices2(com.sas.metadata.remote.SoftwareComponent softwareComponent) throws ServiceException
ServiceComponent
elements that are defined within the specified
SoftwareComponent
.
softwareComponent
-
ServiceComponent
. An empty
list is returned in the event that no ServiceComponent
elements were
found.
ServiceException
- if unable to get the services for the software component.public static final com.sas.metadata.remote.SoftwareComponent getServiceDeployment(com.sas.metadata.remote.MdStore mdStore, java.lang.String repositoryID, java.lang.String serviceDeploymentName) throws ServiceException
SoftwareComponent
for the specified foundation services deployment from
the SAS metadata repository.
mdStore
- Metadata object store to be used to create the metadata
SoftwareComponent
objects.repositoryID
- Id of the metadata repository.serviceDeploymentName
- The name of the foundation services deployment
(SoftwareComponent.Name) that is to be obtained from the metadata store.
SoftwareComponent
for the specified name or null
if a
service deployment was not found.
ServiceException
- if unable to get the SoftwareComponent
that represents the
foundation services deployment.public static final com.sas.metadata.remote.SoftwareComponent getServiceDeploymentForID(com.sas.metadata.remote.MdStore mdStore, java.lang.String repositoryID, java.lang.String serviceDeploymentID) throws ServiceException
SoftwareComponent
for the specified foundation services deployment from
the SAS metadata repository for the specified FQID.
mdStore
- Metadata object store to be used to create the metadata
SoftwareComponent
objects.repositoryID
- Id of the metadata repository.serviceDeploymentID
- The FQID of the foundation services deployment
(SoftwareComponent.Id) that is to be obtained from the metadata store.
SoftwareComponent
for the specified name or null
if a
service deployment was not found.
ServiceException
- if unable to get the SoftwareComponent
that represents the
foundation services deployment.public static final java.util.List<com.sas.metadata.remote.SoftwareComponent> getServiceDeployments(com.sas.metadata.remote.MdStore mdStore, java.lang.String repositoryID, java.util.Set<java.lang.String> serviceDeploymentsToFind) throws ServiceException
SoftwareComponent
elements from the specified open metadata repository.
mdStore
- Metadata object store to be used to create the metadata
SoftwareComponent
objects.repositoryID
- Id of the metadata repository.serviceDeploymentsToFind
- Set of String elements representing the
SoftwareComponent.Name that is to be obtained from the metadata store.
SoftwareComponent
. An empty list is
returned in the event that no SoftwareComponent
elements were found.
ServiceException
- if unable to determine the service deployments.public static final java.util.List<com.sas.metadata.remote.SoftwareComponent> getServiceDeploymentsUsingID(com.sas.metadata.remote.MdStore mdStore, java.lang.String repositoryID, java.util.Set<java.lang.String> serviceDeploymentIDsToFind) throws ServiceException
SoftwareComponent
elements from the specified open metadata repository.
mdStore
- Metadata object store to be used to create the metadata
SoftwareComponent
objects.repositoryID
- Id of the metadata repository.serviceDeploymentIDsToFind
- Set of String elements representing one or more FQIDs
(SoftwareComponent.Id of SAS Foundation Services deployments ) that are to be
obtained from the metadata store.
SoftwareComponent
. An empty list is
returned in the event that no SoftwareComponent
elements were found.
ServiceException
- if unable to determine the service deployments.public static final com.sas.metadata.remote.ServiceComponent getServiceComponent(com.sas.metadata.remote.MdStore mdStore, java.lang.String repositoryID, java.lang.String softwareComponentName, java.lang.String groupName, java.lang.String serviceComponentName) throws ServiceException
ServiceComponent
from the specified open metadata repository.
mdStore
- Metadata object store to be used to create the metadata
SoftwareComponent
objects.repositoryID
- Id of the metadata repository.softwareComponentName
- The service deployment's name (i.e. SoftwareComponent.Name).groupName
- The service group's name (i.e. Tree.Name).serviceComponentName
- The service component's name (i.e. ServiceComponent.Name).
SoftwareComponent
. An empty
list is returned in the event that no SoftwareComponent
elements were
found.
ServiceException
- if unable to determine the service deployments.public static final java.lang.String[] getNames(com.sas.meta.SASOMI.IOMI iomi, java.lang.String repositoryID) throws ServiceException
iomi
- IOMI to be used for the request.repositoryID
- The ID of the metadata repository to be queried.
ServiceException
- if unable to perform the request. This exception may chain a
com.sas.iom.SASIOMDefs.GenericError
which would provide additional
details describing the failure.
java.lang.IllegalArgumentException
- if an invalid IOMI or repositoryID parameter is specified.
|
Foundation |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |