Class PlatformManagerClient
java.lang.Object
org.odpi.openmetadata.accessservices.itinfrastructure.client.AssetManagerClientBase
org.odpi.openmetadata.accessservices.itinfrastructure.client.PlatformManagerClient
- All Implemented Interfaces:
DeploymentManagementInterface
,ServerPurposeManagerInterface
,SoftwareServerPlatformManagerInterface
public class PlatformManagerClient
extends AssetManagerClientBase
implements SoftwareServerPlatformManagerInterface
PlatformManagerClient supports the APIs to maintain software server platforms and their related objects.
-
Constructor Summary
ConstructorsConstructorDescriptionPlatformManagerClient
(String serverName, String serverPlatformURLRoot) Create a new client with no authentication embedded in the HTTP request.PlatformManagerClient
(String serverName, String serverPlatformURLRoot, String userId, String password) Create a new client that passes userId and password in each HTTP request.PlatformManagerClient
(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog) Create a new client that passes userId and password in each HTTP request.PlatformManagerClient
(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize) Create a new client that is going to be used in an OMAG Server.PlatformManagerClient
(String serverName, String serverPlatformURLRoot, AuditLog auditLog) Create a new client with no authentication embedded in the HTTP request. -
Method Summary
Modifier and TypeMethodDescriptioncreateSoftwareServerPlatform
(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, SoftwareServerPlatformProperties platformProperties) Create a new metadata element to represent a platform.createSoftwareServerPlatformFromTemplate
(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, TemplateProperties templateProperties) Create a new metadata element to represent a platform using an existing metadata element as a template.findSoftwareServerPlatforms
(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize) Retrieve the list of platform metadata elements that contain the search string.getSoftwareServerPlatformByGUID
(String userId, String guid) Retrieve the platform metadata element with the supplied unique identifier.getSoftwareServerPlatformsByName
(String userId, String name, Date effectiveTime, int startFrom, int pageSize) Retrieve the list of platform metadata elements with a matching qualified or display name.getSoftwareServerPlatformsForInfrastructureManager
(String userId, String infrastructureManagerGUID, String infrastructureManagerName, Date effectiveTime, int startFrom, int pageSize) Retrieve the list of platforms created by this caller.void
publishSoftwareServerPlatform
(String userId, String platformGUID) Update the zones for the platform asset so that it becomes visible to consumers.void
removeSoftwareServerPlatform
(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String platformGUID) Remove the metadata element representing a platform.void
updateSoftwareServerPlatform
(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String platformGUID, boolean isMergeUpdate, SoftwareServerPlatformProperties platformProperties) Update the metadata element representing a platform.void
withdrawSoftwareServerPlatform
(String userId, String platformGUID) Update the zones for the platform asset so that it is no longer visible to consumers.Methods inherited from class org.odpi.openmetadata.accessservices.itinfrastructure.client.AssetManagerClientBase
addServerPurpose, clearDeployment, clearServerPurpose, deployITAsset, getDeployedITAssets, getDeploymentDestinations, updateITAssetDeployment, updateServerPurpose
-
Constructor Details
-
PlatformManagerClient
public PlatformManagerClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog) throws InvalidParameterException Create a new client with no authentication embedded in the HTTP request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesauditLog
- logging destination- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
PlatformManagerClient
public PlatformManagerClient(String serverName, String serverPlatformURLRoot) throws InvalidParameterException Create a new client with no authentication embedded in the HTTP request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST services- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
PlatformManagerClient
public PlatformManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password) throws InvalidParameterException Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesuserId
- caller's userId embedded in all HTTP requestspassword
- caller's userId embedded in all HTTP requests- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
PlatformManagerClient
public PlatformManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog) throws InvalidParameterException Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesuserId
- caller's userId embedded in all HTTP requestspassword
- caller's userId embedded in all HTTP requestsauditLog
- logging destination- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
PlatformManagerClient
public PlatformManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize) throws InvalidParameterException Create a new client that is going to be used in an OMAG Server.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesrestClient
- client that issues the REST API callsmaxPageSize
- maximum number of results supported by this server- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
-
Method Details
-
createSoftwareServerPlatform
public String createSoftwareServerPlatform(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, SoftwareServerPlatformProperties platformProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a new metadata element to represent a platform.- Specified by:
createSoftwareServerPlatform
in interfaceSoftwareServerPlatformManagerInterface
- Parameters:
userId
- calling userinfrastructureManagerGUID
- unique identifier of software server capability representing the infrastructure managerinfrastructureManagerName
- unique name of software server capability representing the infrastructure managerinfrastructureManagerIsHome
- should the platform be marked as owned by the infrastructure manager so others can not update?platformProperties
- properties to store- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createSoftwareServerPlatformFromTemplate
public String createSoftwareServerPlatformFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a new metadata element to represent a platform using an existing metadata element as a template.- Specified by:
createSoftwareServerPlatformFromTemplate
in interfaceSoftwareServerPlatformManagerInterface
- Parameters:
userId
- calling userinfrastructureManagerGUID
- unique identifier of software server capability representing the infrastructure managerinfrastructureManagerName
- unique name of software server capability representing the infrastructure managerinfrastructureManagerIsHome
- should the platform be marked as owned by the infrastructure manager so others can not update?templateGUID
- unique identifier of the metadata element to copytemplateProperties
- properties that override the template- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateSoftwareServerPlatform
public void updateSoftwareServerPlatform(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String platformGUID, boolean isMergeUpdate, SoftwareServerPlatformProperties platformProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the metadata element representing a platform.- Specified by:
updateSoftwareServerPlatform
in interfaceSoftwareServerPlatformManagerInterface
- Parameters:
userId
- calling userinfrastructureManagerGUID
- unique identifier of software server capability representing the infrastructure managerinfrastructureManagerName
- unique name of software server capability representing the infrastructure managerplatformGUID
- unique identifier of the metadata element to updateisMergeUpdate
- are unspecified properties unchanged (true) or removed?platformProperties
- new properties for this element- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
publishSoftwareServerPlatform
public void publishSoftwareServerPlatform(String userId, String platformGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the zones for the platform asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the IT Infrastructure OMAS).- Specified by:
publishSoftwareServerPlatform
in interfaceSoftwareServerPlatformManagerInterface
- Parameters:
userId
- calling userplatformGUID
- unique identifier of the metadata element to publish- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
withdrawSoftwareServerPlatform
public void withdrawSoftwareServerPlatform(String userId, String platformGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the zones for the platform asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS. This is the setting when the platform is first created).- Specified by:
withdrawSoftwareServerPlatform
in interfaceSoftwareServerPlatformManagerInterface
- Parameters:
userId
- calling userplatformGUID
- unique identifier of the metadata element to withdraw- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
removeSoftwareServerPlatform
public void removeSoftwareServerPlatform(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String platformGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the metadata element representing a platform.- Specified by:
removeSoftwareServerPlatform
in interfaceSoftwareServerPlatformManagerInterface
- Parameters:
userId
- calling userinfrastructureManagerGUID
- unique identifier of software server capability representing the infrastructure managerinfrastructureManagerName
- unique name of software server capability representing the infrastructure managerplatformGUID
- unique identifier of the metadata element to remove- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
findSoftwareServerPlatforms
public List<SoftwareServerPlatformElement> findSoftwareServerPlatforms(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of platform metadata elements that contain the search string. The search string is treated as a regular expression.- Specified by:
findSoftwareServerPlatforms
in interfaceSoftwareServerPlatformManagerInterface
- Parameters:
userId
- calling usersearchString
- string to find in the propertieseffectiveTime
- effective time for the querystartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getSoftwareServerPlatformsByName
public List<SoftwareServerPlatformElement> getSoftwareServerPlatformsByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of platform metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Specified by:
getSoftwareServerPlatformsByName
in interfaceSoftwareServerPlatformManagerInterface
- Parameters:
userId
- calling username
- name to search foreffectiveTime
- effective time for the querystartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getSoftwareServerPlatformsForInfrastructureManager
public List<SoftwareServerPlatformElement> getSoftwareServerPlatformsForInfrastructureManager(String userId, String infrastructureManagerGUID, String infrastructureManagerName, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of platforms created by this caller.- Specified by:
getSoftwareServerPlatformsForInfrastructureManager
in interfaceSoftwareServerPlatformManagerInterface
- Parameters:
userId
- calling userinfrastructureManagerGUID
- unique identifier of software server capability representing the infrastructure managerinfrastructureManagerName
- unique name of software server capability representing the infrastructure managereffectiveTime
- effective time for the querystartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getSoftwareServerPlatformByGUID
public SoftwareServerPlatformElement getSoftwareServerPlatformByGUID(String userId, String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the platform metadata element with the supplied unique identifier.- Specified by:
getSoftwareServerPlatformByGUID
in interfaceSoftwareServerPlatformManagerInterface
- Parameters:
userId
- calling userguid
- unique identifier of the requested metadata element- Returns:
- matching metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-