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

Class ServerManagerClient

java.lang.Object

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

org.odpi.openmetadata.accessservices.itinfrastructure.client.ServerManagerClient

All Implemented Interfaces:

DeploymentManagementInterface, ServerPurposeManagerInterface, SoftwareServerManagerInterface

public class ServerManagerClient
extends ITInfrastructureClientBase
implements SoftwareServerManagerInterface

ServerManagerClient supports the APIs to maintain servers and their related objects.

Constructor Summary

Constructors

Constructor	Description
ServerManagerClient(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
ServerManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
ServerManagerClient(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.
ServerManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)	Create a new client that is going to be used in an OMAG Server.
ServerManagerClient(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	createSoftwareServer(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, SoftwareServerProperties softwareServerProperties)	Create a new metadata element to represent a software server.
String	createSoftwareServerFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a software server using an existing metadata element as a template.
List<SoftwareServerElement>	findSoftwareServers(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of software server metadata elements that contain the search string.
SoftwareServerElement	getSoftwareServerByGUID(String userId, String guid)	Retrieve the softwareServer metadata element with the supplied unique identifier.
List<SoftwareServerElement>	getSoftwareServersByDeployedImplType(String userId, String name, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of server metadata elements with a matching deployed implementation type.
List<SoftwareServerElement>	getSoftwareServersByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of softwareServer metadata elements with a matching qualified or display name.
List<SoftwareServerElement>	getSoftwareServersForInfrastructureManager(String userId, String infrastructureManagerGUID, String infrastructureManagerName, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of software servers created by this caller.
void	publishSoftwareServer(String userId, String softwareServerGUID)	Update the zones for the software server asset so that it becomes visible to consumers.
void	removeSoftwareServer(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String softwareServerGUID)	Remove the metadata element representing a software server.
void	updateSoftwareServer(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String softwareServerGUID, boolean isMergeUpdate, SoftwareServerProperties softwareServerProperties)	Update the metadata element representing a software server.
void	withdrawSoftwareServer(String userId, String softwareServerGUID)	Update the zones for the software server 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

ServerManagerClient

public ServerManagerClient(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.

ServerManagerClient

public ServerManagerClient(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.

ServerManagerClient

public ServerManagerClient(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.

ServerManagerClient

public ServerManagerClient(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.

ServerManagerClient

public ServerManagerClient(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

createSoftwareServer

public String createSoftwareServer(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 SoftwareServerProperties softwareServerProperties)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a software server.

Specified by:

createSoftwareServer in interface SoftwareServerManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

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

softwareServerProperties - 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)

createSoftwareServerFromTemplate

public String createSoftwareServerFromTemplate(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String templateGUID,
 TemplateProperties templateProperties)
                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a software server using an existing metadata element as a template.

Specified by:

createSoftwareServerFromTemplate in interface SoftwareServerManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

infrastructureManagerIsHome - should the softwareServer 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)

updateSoftwareServer

public void updateSoftwareServer(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String softwareServerGUID,
 boolean isMergeUpdate,
 SoftwareServerProperties softwareServerProperties)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a software server.

Specified by:

updateSoftwareServer in interface SoftwareServerManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

softwareServerGUID - unique identifier of the metadata element to update

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

softwareServerProperties - 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)

publishSoftwareServer

public void publishSoftwareServer(String userId,
 String softwareServerGUID)
                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the zones for the software server 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:

publishSoftwareServer in interface SoftwareServerManagerInterface

Parameters:

userId - calling user

softwareServerGUID - 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)

withdrawSoftwareServer

public void withdrawSoftwareServer(String userId,
 String softwareServerGUID)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the zones for the software server 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 softwareServer is first created).

Specified by:

withdrawSoftwareServer in interface SoftwareServerManagerInterface

Parameters:

userId - calling user

softwareServerGUID - 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)

removeSoftwareServer

public void removeSoftwareServer(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String softwareServerGUID)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a software server.

Specified by:

removeSoftwareServer in interface SoftwareServerManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

softwareServerGUID - 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)

findSoftwareServers

public List<SoftwareServerElement> findSoftwareServers(String userId,
 String searchString,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of software server metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findSoftwareServers in interface SoftwareServerManagerInterface

Parameters:

userId - calling user

searchString - string to find in the properties

effectiveTime - time that the element is effective

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)

getSoftwareServersByName

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

Retrieve the list of softwareServer metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getSoftwareServersByName in interface SoftwareServerManagerInterface

Parameters:

userId - calling user

name - name to search for

effectiveTime - time that the element is effective

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)

getSoftwareServersByDeployedImplType

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

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

Specified by:

getSoftwareServersByDeployedImplType in interface SoftwareServerManagerInterface

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)

getSoftwareServersForInfrastructureManager

public List<SoftwareServerElement> getSoftwareServersForInfrastructureManager(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of software servers created by this caller.

Specified by:

getSoftwareServersForInfrastructureManager in interface SoftwareServerManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

effectiveTime - time that the element is effective

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)

getSoftwareServerByGUID

public SoftwareServerElement getSoftwareServerByGUID(String userId,
 String guid)
                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the softwareServer metadata element with the supplied unique identifier.

Specified by:

getSoftwareServerByGUID in interface SoftwareServerManagerInterface

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)