java.lang.Object
- org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
- - org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
  - - org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.OCFRESTClient
    - - org.odpi.openmetadata.accessservices.itinfrastructure.client.rest.ITInfrastructureRESTClient

```
public class ITInfrastructureRESTClient
extends OCFRESTClient
```
ITInfrastructureRESTClient is responsible for issuing calls to the OMAS REST APIs.

Field Summary
- Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
  auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors
Constructor	Description
`ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot)`	Constructor for no authentication.
`ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)`	Constructor for simple userId and password authentication.
`ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)`	Constructor for simple userId and password authentication with audit log.
`ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)`	Constructor for no authentication with audit log.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ElementStubResponse`	`callElementStubGetRESTCall(String methodName, String urlTemplate, Object... params)`	Issue a GET REST call that returns a ElementStubResponse object.
`ITProfileResponse`	`callITProfileGetRESTCall(String methodName, String urlTemplate, Object... params)`	Issue a GET REST call that returns a ITProfileElement in a response object.
`ITProfileListResponse`	`callITProfileListGetRESTCall(String methodName, String urlTemplate, Object... params)`	Issue a GET REST call that returns a list of ITProfileElements in a response object.
`ITProfileListResponse`	`callITProfileListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)`	Issue a GET REST call that returns a list of ITProfileElements in a response object.
`ConnectionResponse`	`callMyConnectionGetRESTCall(String methodName, String urlTemplate, Object... params)`	Issue a GET REST call that returns a ConnectionResponse object.
`ConnectionsResponse`	`callMyConnectionsGetRESTCall(String methodName, String urlTemplate, Object... params)`	Issue a POST REST call that returns a ConnectionsResponse object.
`ConnectionsResponse`	`callMyConnectionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)`	Issue a POST REST call that returns a ConnectionsResponse object.
`ConnectorTypeResponse`	`callMyConnectorTypeGetRESTCall(String methodName, String urlTemplate, Object... params)`	Issue a GET REST call that returns a ConnectorTypeResponse object.
`ConnectorTypesResponse`	`callMyConnectorTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)`	Issue a POST REST call that returns a ConnectorTypesResponse object.
`EndpointResponse`	`callMyEndpointGetRESTCall(String methodName, String urlTemplate, Object... params)`	Issue a GET REST call that returns a EndpointResponse object.
`EndpointsResponse`	`callMyEndpointsGetRESTCall(String methodName, String urlTemplate, Object... params)`	Issue a GET REST call that returns a EndpointsResponse object.
`EndpointsResponse`	`callMyEndpointsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)`	Issue a POST REST call that returns a EndpointsResponse object.
`UserIdentityResponse`	`callUserIdentityGetRESTCall(String methodName, String urlTemplate, Object... params)`	Issue a GET REST call that returns a UserIdentityElement in a response object.
`UserIdentityListResponse`	`callUserIdentityListGetRESTCall(String methodName, String urlTemplate, Object... params)`	Issue a GET REST call that returns a list of UserIdentityElements in a response object.
`UserIdentityListResponse`	`callUserIdentityListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)`	Issue a POST REST call that returns a list of UserIdentityElements in a response object.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.OCFRESTClient
callAssetGetRESTCall, callAssetsGetRESTCall, callAssetsPostRESTCall, callConnectionGetRESTCall, callTagGetRESTCall, callTagListGetRESTCall, callTagListPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
callConnectorTypeGetRESTCall, callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
callDeleteRESTCall, callDeleteRESTCall, callGetRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCall

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ITInfrastructureRESTClient
```
public ITInfrastructureRESTClient(String serverName,
                                  String serverPlatformURLRoot,
                                  AuditLog auditLog)
                           throws InvalidParameterException
```
  Constructor for no authentication with audit log.
  
  Parameters:
  
  serverName - name of the OMAG Server to call
  
  serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
  
  auditLog - destination for log messages.
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
- ITInfrastructureRESTClient
```
public ITInfrastructureRESTClient(String serverName,
                                  String serverPlatformURLRoot)
                           throws InvalidParameterException
```
  Constructor for no authentication.
  
  Parameters:
  
  serverName - name of the OMAG Server to call
  
  serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
- ITInfrastructureRESTClient
```
public ITInfrastructureRESTClient(String serverName,
                                  String serverPlatformURLRoot,
                                  String userId,
                                  String password,
                                  AuditLog auditLog)
                           throws InvalidParameterException
```
  Constructor for simple userId and password authentication with audit log.
  
  Parameters:
  
  serverName - name of the OMAG Server to call
  
  serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
  
  userId - user id for the HTTP request
  
  password - password for the HTTP request
  
  auditLog - destination for log messages.
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
- ITInfrastructureRESTClient
```
public ITInfrastructureRESTClient(String serverName,
                                  String serverPlatformURLRoot,
                                  String userId,
                                  String password)
                           throws InvalidParameterException
```
  Constructor for simple userId and password authentication.
  
  Parameters:
  
  serverName - name of the OMAG Server to call
  
  serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
  
  userId - user id for the HTTP request
  
  password - password for the HTTP request
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

callMyConnectionGetRESTCall

public ConnectionResponse callMyConnectionGetRESTCall(String methodName,
                                                      String urlTemplate,
                                                      Object... params)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Issue a GET REST call that returns a ConnectionResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call with place-holders for the parameters.; params - a list of parameters that are slotted into the url template.
Returns:: ConnectionResponse
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - the repository is not available or not working properly.

callMyConnectionsGetRESTCall

public ConnectionsResponse callMyConnectionsGetRESTCall(String methodName,
                                                        String urlTemplate,
                                                        Object... params)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Issue a POST REST call that returns a ConnectionsResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call with place-holders for the parameters.; params - a list of parameters that are slotted into the url template.
Returns:: ConnectionsResponse
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - the repository is not available or not working properly.

callMyConnectionsPostRESTCall

public ConnectionsResponse callMyConnectionsPostRESTCall(String methodName,
                                                         String urlTemplate,
                                                         Object requestBody,
                                                         Object... params)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Issue a POST REST call that returns a ConnectionsResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call with place-holders for the parameters.; requestBody - properties describing the valid value definition/set; params - a list of parameters that are slotted into the url template.
Returns:: ConnectionsResponse
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - the repository is not available or not working properly.

callMyConnectorTypeGetRESTCall

public ConnectorTypeResponse callMyConnectorTypeGetRESTCall(String methodName,
                                                            String urlTemplate,
                                                            Object... params)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Issue a GET REST call that returns a ConnectorTypeResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call with place-holders for the parameters.; params - a list of parameters that are slotted into the url template.
Returns:: ConnectorTypeResponse
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - the repository is not available or not working properly.

callMyConnectorTypesPostRESTCall

public ConnectorTypesResponse callMyConnectorTypesPostRESTCall(String methodName,
                                                               String urlTemplate,
                                                               Object requestBody,
                                                               Object... params)
                                                        throws InvalidParameterException,
                                                               UserNotAuthorizedException,
                                                               PropertyServerException

Issue a POST REST call that returns a ConnectorTypesResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call with place-holders for the parameters.; requestBody - properties describing the valid value definition/set; params - a list of parameters that are slotted into the url template.
Returns:: ConnectorTypesResponse
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - the repository is not available or not working properly.

callMyEndpointGetRESTCall

public EndpointResponse callMyEndpointGetRESTCall(String methodName,
                                                  String urlTemplate,
                                                  Object... params)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Issue a GET REST call that returns a EndpointResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call with place-holders for the parameters.; params - a list of parameters that are slotted into the url template.
Returns:: EndpointResponse
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - the repository is not available or not working properly.

callMyEndpointsGetRESTCall

public EndpointsResponse callMyEndpointsGetRESTCall(String methodName,
                                                    String urlTemplate,
                                                    Object... params)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Issue a GET REST call that returns a EndpointsResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call with place-holders for the parameters.; params - a list of parameters that are slotted into the url template.
Returns:: EndpointsResponse
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - the repository is not available or not working properly.

callMyEndpointsPostRESTCall

public EndpointsResponse callMyEndpointsPostRESTCall(String methodName,
                                                     String urlTemplate,
                                                     Object requestBody,
                                                     Object... params)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Issue a POST REST call that returns a EndpointsResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call with place-holders for the parameters.; requestBody - properties describing the valid value definition/set; params - a list of parameters that are slotted into the url template.
Returns:: EndpointsResponse
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - the repository is not available or not working properly.

callElementStubGetRESTCall

public ElementStubResponse callElementStubGetRESTCall(String methodName,
                                                      String urlTemplate,
                                                      Object... params)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Issue a GET REST call that returns a ElementStubResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call with place-holders for the parameters.; params - a list of parameters that are slotted into the url template.
Returns:: response object
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - the repository is not available or not working properly.

callITProfileGetRESTCall

public ITProfileResponse callITProfileGetRESTCall(String methodName,
                                                  String urlTemplate,
                                                  Object... params)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Issue a GET REST call that returns a ITProfileElement in a response object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call with place-holders for the parameters.; params - a list of parameters that are slotted into the url template.
Returns:: response object
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - something went wrong with the REST call stack.

callITProfileListGetRESTCall

public ITProfileListResponse callITProfileListGetRESTCall(String methodName,
                                                          String urlTemplate,
                                                          Object... params)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Issue a GET REST call that returns a list of ITProfileElements in a response object.

Parameters:: methodName - name of the method being called; urlTemplate - template of the URL for the REST API call with place-holders for the parameters; params - a list of parameters that are slotted into the url template
Returns:: response object
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - something went wrong with the REST call stack.

callITProfileListPostRESTCall

public ITProfileListResponse callITProfileListPostRESTCall(String methodName,
                                                           String urlTemplate,
                                                           Object requestBody,
                                                           Object... params)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Issue a GET REST call that returns a list of ITProfileElements in a response object.

Parameters:: methodName - name of the method being called; urlTemplate - template of the URL for the REST API call with place-holders for the parameters; requestBody - request body for the request; params - a list of parameters that are slotted into the url template
Returns:: response object
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - something went wrong with the REST call stack.

callUserIdentityGetRESTCall

public UserIdentityResponse callUserIdentityGetRESTCall(String methodName,
                                                        String urlTemplate,
                                                        Object... params)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Issue a GET REST call that returns a UserIdentityElement in a response object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call with place-holders for the parameters.; params - a list of parameters that are slotted into the url template.
Returns:: UserIdentityResponse
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - something went wrong with the REST call stack.

callUserIdentityListGetRESTCall

public UserIdentityListResponse callUserIdentityListGetRESTCall(String methodName,
                                                                String urlTemplate,
                                                                Object... params)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

Issue a GET REST call that returns a list of UserIdentityElements in a response object.

Parameters:: methodName - name of the method being called; urlTemplate - template of the URL for the REST API call with place-holders for the parameters; params - a list of parameters that are slotted into the url template
Returns:: UserIdentityListResponse
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - something went wrong with the REST call stack.

callUserIdentityListPostRESTCall

public UserIdentityListResponse callUserIdentityListPostRESTCall(String methodName,
                                                                 String urlTemplate,
                                                                 Object requestBody,
                                                                 Object... params)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException

Issue a POST REST call that returns a list of UserIdentityElements in a response object.

Parameters:: methodName - name of the method being called; urlTemplate - template of the URL for the REST API call with place-holders for the parameters; requestBody - request body for the request; params - a list of parameters that are slotted into the url template
Returns:: UserIdentityListResponse
Throws:: InvalidParameterException - one of the parameters is invalid.; UserNotAuthorizedException - the user is not authorized to make this request.; PropertyServerException - something went wrong with the REST call stack.

Class ITInfrastructureRESTClient

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.OCFRESTClient

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

Methods inherited from class java.lang.Object

Constructor Detail

ITInfrastructureRESTClient

ITInfrastructureRESTClient

ITInfrastructureRESTClient

ITInfrastructureRESTClient

Method Detail

callMyConnectionGetRESTCall

callMyConnectionsGetRESTCall

callMyConnectionsPostRESTCall

callMyConnectorTypeGetRESTCall

callMyConnectorTypesPostRESTCall

callMyEndpointGetRESTCall

callMyEndpointsGetRESTCall

callMyEndpointsPostRESTCall

callElementStubGetRESTCall

callITProfileGetRESTCall

callITProfileListGetRESTCall

callITProfileListPostRESTCall

callUserIdentityGetRESTCall

callUserIdentityListGetRESTCall

callUserIdentityListPostRESTCall