org.odpi.openmetadata.frameworks.connectors.properties

Class EndpointProperties

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

org.odpi.openmetadata.frameworks.connectors.properties.EndpointProperties

All Implemented Interfaces:

Serializable

public class EndpointProperties
extends AssetReferenceable

The Endpoint describes the network information necessary for a connector to connect to the server where the Asset is accessible from. The properties for an endpoint are defined in model 0040. They include:

• type definition of the specific metadata type for the endpoint.
• guid Globally unique identifier for the endpoint.
• url External link address for the endpoint properties in the metadata repository. This URL can be stored as a property in another entity to create an explicit link to this endpoint.
• qualifiedName The official (unique) name for the endpoint. This is often defined by the IT systems management organization and should be used (when available) on audit logs and error messages.
• displayName - A consumable name for the endpoint. Often a shortened form of the qualifiedName for use on user interfaces and messages. The displayName should be only be used for audit logs and error messages if the qualifiedName is not set.
• description - A description for the endpoint.
• address - The location of the asset. For network connected resources, this is typically the URL and port number (if needed) for the server where the asset is located (or at least accessible by the connector). For file-based resources, this is typically the name of the file.
• protocol - The communication protocol that the connection should use to connect to the server.
• encryptionMethod - Describes the encryption method to use (if any). This is an open value allowing information needed by the connector user to retrieve all of the information they need to work with the endpoint.
• additionalProperties - Any additional properties that the connector need to know in order to access the Asset.

The Endpoint class is simply used to cache the properties for an endpoint. It is used by other classes to exchange this information between a metadata repository and a consumer.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Endpoint	endpointBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

referenceableBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

parentAsset

Constructor Summary

Constructors

Constructor and Description
EndpointProperties(AssetDescriptor parentAsset, Endpoint endpointBean) Bean constructor with parent asset
EndpointProperties(AssetDescriptor parentAsset, EndpointProperties templateEndpoint) Copy/clone constructor for an Endpoint that is connected to an Asset (either directly or indirectly).
EndpointProperties(Endpoint endpointBean) Bean constructor
EndpointProperties(EndpointProperties templateEndpoint) Copy/clone constructor for an Endpoint that is connected to an Asset (either directly or indirectly).

Method Summary

Modifier and Type	Method and 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	getDescription() Return the description for the endpoint.
String	getDisplayName() Returns the stored display name property for the endpoint.
String	getEncryptionMethod() Returns the stored encryptionMethod property for the endpoint.
protected Endpoint	getEndpointBean() Return the Endpoint bean that contains all of the properties.
String	getProtocol() Returns the stored protocol property for the endpoint.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

getAdditionalProperties, getMeanings, getQualifiedName, getReferenceableBean, setBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

getAssetClassifications, getElementHeaderBean, getExtendedProperties, getGUID, getType, getURL, hashCode, setBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

getParentAsset, getParentAssetName, getParentAssetTypeName

Methods inherited from class java.lang.Object

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

Field Detail

endpointBean

protected Endpoint endpointBean

Constructor Detail

EndpointProperties

public EndpointProperties(Endpoint endpointBean)

Bean constructor

Parameters:

endpointBean - bean containing the properties

EndpointProperties

public EndpointProperties(AssetDescriptor parentAsset,
                          Endpoint endpointBean)

Bean constructor with parent asset

Parameters:

parentAsset - description of the asset that this endpoint is attached to.

endpointBean - bean containing the properties

EndpointProperties

public EndpointProperties(EndpointProperties templateEndpoint)

Copy/clone constructor for an Endpoint that is connected to an Asset (either directly or indirectly).

Parameters:

templateEndpoint - template object to copy.

EndpointProperties

public EndpointProperties(AssetDescriptor parentAsset,
                          EndpointProperties templateEndpoint)

Copy/clone constructor for an Endpoint that is connected to an Asset (either directly or indirectly).

Parameters:

parentAsset - description of the asset that this endpoint is attached to.

templateEndpoint - template object to copy.

Method Detail

getEndpointBean

protected Endpoint getEndpointBean()

Return the Endpoint bean that contains all of the properties.

Returns:

Endpoint bean

getDisplayName

public String getDisplayName()

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

Returns:

displayName

getDescription

public String getDescription()

Return the description for the endpoint.

Returns:

String description

getAddress

public String getAddress()

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

Returns:

address

getProtocol

public String getProtocol()

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

Returns:

protocol

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 AssetReferenceable

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 AssetReferenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison