Package org.odpi.openmetadata.accessservices.digitalarchitecture.properties

Class EndpointProperties

java.lang.Object

org.odpi.openmetadata.accessservices.digitalarchitecture.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.digitalarchitecture.properties.EndpointProperties

All Implemented Interfaces:

Serializable

public class EndpointProperties
extends ReferenceableProperties

EndpointProperties describes the properties of a server endpoint.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
EndpointProperties()	Default constructor
EndpointProperties(EndpointProperties template)	Copy/clone constructor for an Endpoint.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
String	getAddress()	Returns the stored address property for the endpoint.
String	getEncryptionMethod()	Returns the stored encryptionMethod property for the endpoint.
String	getProtocol()	Returns the stored protocol property for the endpoint.
String	getResourceDescription()	Return the technical description for the endpoint.
String	getResourceName()	Returns the stored technical name property for the endpoint.
int	hashCode()	Create a hash code for this element type.
void	setAddress(String address)	Set up the network address of the endpoint.
void	setEncryptionMethod(String encryptionMethod)	Set up the encryption method used on this Endpoint.
void	setProtocol(String protocol)	Set up the protocol to use for this Endpoint
void	setResourceDescription(String resourceDescription)	Set up the technical description of the endpoint.
void	setResourceName(String resourceName)	Set up the technical name for the endpoint.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.accessservices.digitalarchitecture.properties.ReferenceableProperties

getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointProperties

public EndpointProperties()

Default constructor

EndpointProperties

public EndpointProperties(EndpointProperties template)

Copy/clone constructor for an Endpoint.

Parameters:

template - template object to copy.

Method Detail

setResourceName

public void setResourceName(String resourceName)

Set up the technical name for the endpoint.

Parameters:

resourceName - String name

getResourceName

public String getResourceName()

Returns the stored technical name property for the endpoint. If no technical name is available then null is returned.

Returns:

String name

setResourceDescription

public void setResourceDescription(String resourceDescription)

Set up the technical description of the endpoint.

Parameters:

resourceDescription - String

getResourceDescription

public String getResourceDescription()

Return the technical description for the endpoint.

Returns:

String technicalDescription

setAddress

public void setAddress(String address)

Set up the network address of the endpoint.

Parameters:

address - String resource name

getAddress

public String getAddress()

Returns the stored address property for the endpoint. If no network address is available then null is returned.

Returns:

address

setProtocol

public void setProtocol(String protocol)

Set up the protocol to use for this Endpoint

Parameters:

protocol - String protocol name

getProtocol

public String getProtocol()

Returns the stored protocol property for the endpoint. If no protocol is available then null is returned.

Returns:

protocol

setEncryptionMethod

public void setEncryptionMethod(String encryptionMethod)

Set up the encryption method used on this Endpoint.

Parameters:

encryptionMethod - String name

getEncryptionMethod

public String getEncryptionMethod()

Returns the stored encryptionMethod property for the endpoint. This is an open type allowing the information needed to work with a specific encryption mechanism used by the endpoint to be defined. If no encryptionMethod property is available (typically because this is an unencrypted endpoint) then null is returned.

Returns:

encryption method information

toString

public String toString()

Standard toString method.

Overrides:

toString in class ReferenceableProperties

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class ReferenceableProperties

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class ReferenceableProperties

Returns:

int hash code