Package org.odpi.openmetadata.accessservices.itinfrastructure.api

Interface SoftwareServerManagerInterface

All Known Implementing Classes:

ServerManagerClient

public interface SoftwareServerManagerInterface

SoftwareServerManagerInterface defines the client side interface for the IT Infrastructure OMAS that is relevant for softwareServer assets. It provides the ability to define and maintain the metadata about a software server and the capabilities deployed on it.

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 impl 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.

Method Details

createSoftwareServer

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.

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

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.

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

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.

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

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

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

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

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

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

Remove the metadata element representing a software server.

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

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.

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

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.

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

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 impl type. There are no wildcards supported on this request.

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

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.

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

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

Retrieve the softwareServer metadata element with the supplied unique identifier.

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)