Package org.odpi.openmetadata.accessservices.itinfrastructure.client

Class PlatformManagerClient

java.lang.Object

org.odpi.openmetadata.accessservices.itinfrastructure.client.ITInfrastructureClientBase

org.odpi.openmetadata.accessservices.itinfrastructure.client.PlatformManagerClient

All Implemented Interfaces:

DeploymentManagementInterface, ServerPurposeManagerInterface, SoftwareServerPlatformManagerInterface

public class PlatformManagerClient
extends ITInfrastructureClientBase
implements SoftwareServerPlatformManagerInterface

PlatformManagerClient supports the APIs to maintain software server platforms and their related objects.

Constructor Summary

Constructors

Constructor	Description
PlatformManagerClient(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
PlatformManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
PlatformManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog, int maxPageSize)	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, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
String	createSoftwareServerPlatform(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, SoftwareServerPlatformProperties platformProperties)	Create a new metadata element to represent a platform.
String	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.
List<SoftwareServerPlatformElement>	findSoftwareServerPlatforms(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of platform metadata elements that contain the search string.
SoftwareServerPlatformElement	getSoftwareServerPlatformByGUID(String userId, String guid)	Retrieve the platform metadata element with the supplied unique identifier.
List<SoftwareServerPlatformElement>	getSoftwareServerPlatformsByDeployedImplType(String userId, String name, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of platform metadata elements with a matching deployed implementation type.
List<SoftwareServerPlatformElement>	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.
List<SoftwareServerPlatformElement>	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.ITInfrastructureClientBase

addServerPurpose, clearDeployment, clearServerPurpose, deployITAsset, getDeployedITAssets, getDeploymentDestinations, updateITAssetDeployment, updateServerPurpose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlatformManagerClient

public PlatformManagerClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog,
 int maxPageSize)
                      throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

PlatformManagerClient

public PlatformManagerClient(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                      throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

maxPageSize - maximum value allowed for page size

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,
 int maxPageSize)
                      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 to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - maximum value allowed for page size

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,
 int maxPageSize)
                      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 to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

maxPageSize - maximum value allowed for page size

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 to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

restClient - client that issues the REST API calls

maxPageSize - 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 interface SoftwareServerPlatformManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

infrastructureManagerIsHome - 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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 interface SoftwareServerPlatformManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

infrastructureManagerIsHome - should the platform be marked as owned by the infrastructure manager so others can not update?

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 interface SoftwareServerPlatformManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

platformGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

platformProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 interface SoftwareServerPlatformManagerInterface

Parameters:

userId - calling user

platformGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 interface SoftwareServerPlatformManagerInterface

Parameters:

userId - calling user

platformGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 interface SoftwareServerPlatformManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

platformGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 interface SoftwareServerPlatformManagerInterface

Parameters:

userId - calling user

searchString - string to find in the properties

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 interface SoftwareServerPlatformManagerInterface

Parameters:

userId - calling user

name - name to search for

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSoftwareServerPlatformsByDeployedImplType

public List<SoftwareServerPlatformElement> getSoftwareServerPlatformsByDeployedImplType(String userId,
 String name,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of platform metadata elements with a matching deployed implementation type. There are no wildcards supported on this request.

Specified by:

getSoftwareServerPlatformsByDeployedImplType in interface SoftwareServerPlatformManagerInterface

Parameters:

userId - calling user

name - name to search for

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 interface SoftwareServerPlatformManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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 interface SoftwareServerPlatformManagerInterface

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)