org.odpi.openmetadata.accessservices.governanceprogram.client

Class GovernanceProgramExceptionHandler

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramExceptionHandler

public class GovernanceProgramExceptionHandler
extends Object

GovernanceProgramExceptionHandler provides the client-side interface for the Governance Program Open Metadata Access Service (OMAS). This client, manages all of the interaction with an open metadata repository. It is initialized with the URL of the server that is running the Open Metadata Access Services. This server is responsible for locating and managing the governance program definitions exchanged with this client.

Constructor Summary

Constructors

Constructor and Description
GovernanceProgramExceptionHandler(String newServerURL) Create a new GovernanceProgramExceptionHandler.

Method Summary

Modifier and Type	Method and Description
void	detectAndThrowAppointmentIdNotUniqueException(String methodName, GovernanceProgramOMASAPIResponse restResult) Throw an AppointmentIdNotUniqueException if it is encoded in the REST response.
void	detectAndThrowEmployeeNumberNotUniqueException(String methodName, GovernanceProgramOMASAPIResponse restResult) Throw an EmployeeNumberNotUniqueException if it is encoded in the REST response.
void	detectAndThrowInvalidParameterException(String methodName, GovernanceProgramOMASAPIResponse restResult) Throw an InvalidParameterException if it is encoded in the REST response.
void	detectAndThrowPropertyServerException(String methodName, GovernanceProgramOMASAPIResponse restResult) Throw an PropertyServerException if it is encoded in the REST response.
void	detectAndThrowUnrecognizedGUIDException(String methodName, GovernanceProgramOMASAPIResponse restResult) Throw an UnrecognizedGUIDException if it is encoded in the REST response.
void	detectAndThrowUserNotAuthorizedException(String methodName, GovernanceProgramOMASAPIResponse restResult) Throw an UserNotAuthorizedException if it is encoded in the REST response.
void	handleRESTRequestFailure(String methodName, Throwable error) Handles a failed REST call.
void	validateGovernanceDomain(GovernanceDomain governanceDomain, String nameParameter, String methodName) Throw an exception if the supplied GovernanceDomain enum is null
void	validateGUID(String guid, String guidParameter, String expectedTypeName, String methodName) Throw an exception if the supplied guid is null
void	validateName(String name, String nameParameter, String methodName) Throw an exception if the supplied name is null
void	validateOMASServerURL(String methodName) Throw an exception if a server URL has not been supplied on the constructor.
void	validateUserId(String userId, String methodName) Throw an exception if the supplied userId is null

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceProgramExceptionHandler

public GovernanceProgramExceptionHandler(String newServerURL)

Create a new GovernanceProgramExceptionHandler.

Parameters:

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

Method Detail

validateOMASServerURL

public void validateOMASServerURL(String methodName)
                           throws PropertyServerException

Throw an exception if a server URL has not been supplied on the constructor.

Parameters:

methodName - name of the method making the call.

Throws:

PropertyServerException - the server URL is not set

validateUserId

public void validateUserId(String userId,
                           String methodName)
                    throws UserNotAuthorizedException

Throw an exception if the supplied userId is null

Parameters:

userId - user name to validate

methodName - name of the method making the call.

Throws:

UserNotAuthorizedException - the userId is null

validateGUID

public void validateGUID(String guid,
                         String guidParameter,
                         String expectedTypeName,
                         String methodName)
                  throws UnrecognizedGUIDException

Throw an exception if the supplied guid is null

Parameters:

guid - unique identifier to validate

guidParameter - name of the parameter that passed the guid.

expectedTypeName - name of the type for the instance that should have been retrieved.

methodName - name of the method making the call.

Throws:

UnrecognizedGUIDException - the guid is null

validateName

public void validateName(String name,
                         String nameParameter,
                         String methodName)
                  throws InvalidParameterException

Throw an exception if the supplied name is null

Parameters:

name - unique name to validate

nameParameter - name of the parameter that passed the name.

methodName - name of the method making the call.

Throws:

InvalidParameterException - the guid is null

validateGovernanceDomain

public void validateGovernanceDomain(GovernanceDomain governanceDomain,
                                     String nameParameter,
                                     String methodName)
                              throws InvalidParameterException

Throw an exception if the supplied GovernanceDomain enum is null

Parameters:

governanceDomain - domain enum to validate

nameParameter - - name of the parameter that passed the name.

methodName - - name of the method making the call.

Throws:

InvalidParameterException - the guid is null

detectAndThrowUnrecognizedGUIDException

public void detectAndThrowUnrecognizedGUIDException(String methodName,
                                                    GovernanceProgramOMASAPIResponse restResult)
                                             throws UnrecognizedGUIDException

Throw an UnrecognizedGUIDException if it is encoded in the REST response.

Parameters:

methodName - name of the method called

restResult - response from the rest call. This generated in the remote server.

Throws:

UnrecognizedGUIDException - encoded exception from the server

detectAndThrowInvalidParameterException

public void detectAndThrowInvalidParameterException(String methodName,
                                                    GovernanceProgramOMASAPIResponse restResult)
                                             throws InvalidParameterException

Throw an InvalidParameterException if it is encoded in the REST response.

Parameters:

methodName - name of the method called

restResult - response from the rest call. This generated in the remote server.

Throws:

InvalidParameterException - encoded exception from the server

detectAndThrowEmployeeNumberNotUniqueException

public void detectAndThrowEmployeeNumberNotUniqueException(String methodName,
                                                           GovernanceProgramOMASAPIResponse restResult)
                                                    throws EmployeeNumberNotUniqueException

Throw an EmployeeNumberNotUniqueException if it is encoded in the REST response.

Parameters:

methodName - name of the method called

restResult - response from the rest call. This generated in the remote server.

Throws:

EmployeeNumberNotUniqueException - encoded exception from the server

detectAndThrowAppointmentIdNotUniqueException

public void detectAndThrowAppointmentIdNotUniqueException(String methodName,
                                                          GovernanceProgramOMASAPIResponse restResult)
                                                   throws AppointmentIdNotUniqueException

Throw an AppointmentIdNotUniqueException if it is encoded in the REST response.

Parameters:

methodName - name of the method called

restResult - response from the rest call. This generated in the remote server.

Throws:

AppointmentIdNotUniqueException - encoded exception from the server

detectAndThrowPropertyServerException

public void detectAndThrowPropertyServerException(String methodName,
                                                  GovernanceProgramOMASAPIResponse restResult)
                                           throws PropertyServerException

Throw an PropertyServerException if it is encoded in the REST response.

Parameters:

methodName - name of the method called

restResult - response from the rest call. This generated in the remote server.

Throws:

PropertyServerException - encoded exception from the server

detectAndThrowUserNotAuthorizedException

public void detectAndThrowUserNotAuthorizedException(String methodName,
                                                     GovernanceProgramOMASAPIResponse restResult)
                                              throws UserNotAuthorizedException

Throw an UserNotAuthorizedException if it is encoded in the REST response.

Parameters:

methodName - name of the method called

restResult - response from UserNotAuthorizedException encoded exception from the server

Throws:

UserNotAuthorizedException - encoded exception from the server

handleRESTRequestFailure

public void handleRESTRequestFailure(String methodName,
                                     Throwable error)
                              throws PropertyServerException

Handles a failed REST call.

Parameters:

methodName - the name of the method issuing the call.

error - the exception that was returned from the REST call.

Throws:

PropertyServerException - the exception that will wrap the original exception