Package org.odpi.openmetadata.commonservices.ffdc.rest

Class ConnectorTypeResponse

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypeResponse

All Implemented Interfaces:

Serializable, FFDCResponse

public class ConnectorTypeResponse
extends FFDCResponseBase

ConnectorTypeResponse is the response structure used on REST API calls that return a ConnectorType object as a response.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConnectorTypeResponse()	Default constructor
ConnectorTypeResponse(ConnectorReport template)	Copy/clone constructor
ConnectorTypeResponse(ConnectorTypeResponse template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Return comparison result based on the content of the properties.
ComponentDescription	getComponentDescription()	Return the component description information that the connector uses to register with the audit log.
ConnectorType	getConnectorType()	Return the ConnectorType object.
long	getRefreshTimeInterval()	Return the number of minutes between each call to the connector to refresh the metadata.
boolean	getUsesBlockingCalls()	Return if the connector should be started in its own thread to allow it is block on a listening call.
int	hashCode()	Return hash code for this object
void	setComponentDescription(ComponentDescription componentDescription)	Set up the component description information that the connector uses to register with the audit log.
void	setConnectorType(ConnectorType connectorType)	Set up the ConnectorType object.
void	setRefreshTimeInterval(long refreshTimeInterval)	Set up the number of minutes between each call to the connector to refresh the metadata.
void	setUsesBlockingCalls(boolean usesBlockingCalls)	Set up if the connector should be started in its own thread to allow it is block on a listening call.
String	toString()	JSON-style toString

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

getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConnectorTypeResponse

public ConnectorTypeResponse()

Default constructor

ConnectorTypeResponse

public ConnectorTypeResponse(ConnectorTypeResponse template)

Copy/clone constructor

Parameters:

template - object to copy

ConnectorTypeResponse

public ConnectorTypeResponse(ConnectorReport template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getComponentDescription

public ComponentDescription getComponentDescription()

Return the component description information that the connector uses to register with the audit log.

Returns:

component description structure

setComponentDescription

public void setComponentDescription(ComponentDescription componentDescription)

Set up the component description information that the connector uses to register with the audit log.

Parameters:

componentDescription - component description structure

getConnectorType

public ConnectorType getConnectorType()

Return the ConnectorType object.

Returns:

connectorType

setConnectorType

public void setConnectorType(ConnectorType connectorType)

Set up the ConnectorType object.

Parameters:

connectorType - - connectorType object

getRefreshTimeInterval

public long getRefreshTimeInterval()

Return the number of minutes between each call to the connector to refresh the metadata. Zero means that refresh is only called at server start up and whenever the refresh REST API request is made to the integration daemon. If the refresh time interval is greater than 0 then additional calls to refresh are added spaced out by the refresh time interval.

Returns:

minute count

setRefreshTimeInterval

public void setRefreshTimeInterval(long refreshTimeInterval)

Set up the number of minutes between each call to the connector to refresh the metadata. Zero means that refresh is only called at server start up and whenever the refresh REST API request is made to the integration daemon. If the refresh time interval is greater than 0 then additional calls to refresh are added spaced out by the refresh time interval.

Parameters:

refreshTimeInterval - minute count

getUsesBlockingCalls

public boolean getUsesBlockingCalls()

Return if the connector should be started in its own thread to allow it is block on a listening call.

Returns:

boolean flag

setUsesBlockingCalls

public void setUsesBlockingCalls(boolean usesBlockingCalls)

Set up if the connector should be started in its own thread to allow it is block on a listening call.

Parameters:

usesBlockingCalls - boolean flag

toString

public String toString()

JSON-style toString

Overrides:

toString in class FFDCResponseBase

Returns:

return string containing the property names and values

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class FFDCResponseBase

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class FFDCResponseBase

Returns:

int hash code