inspireit.uddi.base
Class AccessPoint

java.lang.Object
  |
  +--inspireit.uddi.base.AccessPoint

All Implemented Interfaces:

java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

public class AccessPoint

extends java.lang.Object

implements java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

The AccessPoint class is a pointer to a service entry point. The notion of service at the metadata level is fairly abstract and many types of entry points are accomodated.

UDDI V2.0: A single attribute is provided (named urlType). The purpose of the urlType is to facilitate searching for entry points associated with a particular type of entry point. An example might be a purchase order service that provides three entry points, one for HTTP, one for SMTP, and one for FAX ordering.

UDDI V3.0: The purpose of the optional attribute useType is to facilitate the description of several types of AccessPoints. The following pre-defined useType attributes values can be used:

• AccessPoint.ENDPOINT: designates that the AccessPoint points to the actual service endpoint, i.e. the network address at which the Web service can be invoked.

• AccessPoint.BINDINGTEMPLATE: designates that the AccessPoint contains a BindingKey that points to a different BindingTemplate entry. The value in providing this facility is seen when a business or entity wants to expose a service description (e.g. advertise that they have a service available that suits a specific purpose) that is actually a service that is described in a separate BindingTemplate record. This might occur when many service descriptions could benefit from a single service description.

• AccessPoint.HOSTINGREDIRECTOR: designates that the AccessPoint can only be determined by querying another UDDI registry. This might occur when a service is remotely hosted.

• AccessPoint.WSDLDEPLOYMENT: designates that the AccessPoint points to a remotely hosted WSDL document that already contains the necessary binding information, including the actual service endpoint.

The useType attribute may contain other values than the four listed above. UDDI recommends that the creation of new useType values should map to UDDI TModelKeys. In such a way, a client can look up the TModel to understand the semantic meaning of this unknown useType attribute. An appropriate UseType instance can be derived from a TModelKey using the adhoc UseType constructor provided by this API.

Author:

Bertrand Fontaine, INSPIRE IT $Revision: 1.2 $

See Also:

UseType, Serialized Form

Field Summary

protected java.lang.String	accessPoint The access point information.
static UseType	BINDINGTEMPLATE AccessPoint use type 'bindingTemplate'.
static UseType	ENDPOINT AccessPoint use type 'endPoint'.
static java.lang.String	FAX Constant for specifying a FAX URL type.
static java.lang.String	FTP Constant for specifying an FTP URL type.
static UseType	HOSTINGREDIRECTOR AccessPoint use type 'hostingRedirector'.
static java.lang.String	HTTP Constant for specifying an HTTP URL type.
static java.lang.String	HTTPS Constant for specifying an HTTPS URL type.
static java.lang.String	MAILTO Constant for specifying a MAILTO URL type.
static java.lang.String	OTHER Constant for specifying another URL type.
static java.lang.String	PHONE Constant for specifying a PHONE URL type.
protected java.lang.String	urlType The URL type.
protected UseType	useType The use type.
static UseType	WSDLDEPLOYMENT AccessPoint use type 'wsdlDeployment'.

Constructor Summary

AccessPoint(java.lang.String accessPoint)
AccessPoint constructor.

AccessPoint(java.lang.String accessPoint, java.lang.String urlType)
Deprecated. as of UDDI V3.0

Method Summary

boolean	equals(java.lang.Object o) Checks whether an object is equal to this AccessPoint.
java.lang.String	getAccessPoint() Gets the AccessPoint information.
java.lang.String	getURLType() Deprecated. as of UDDI V3.0
UseType	getUseType() Gets the AccessPoint use type.
void	setAccessPoint(java.lang.String accessPoint) Sets the AccessPoint information.
void	setURLType(java.lang.String urlType) Deprecated. as of UDDI V3.0
void	setUseType(UseType useType) Sets the AccessPoint use type.
java.lang.String	toString() Gets a string representation of this access point.
java.lang.Object	visit(inspireit.uddi.util.visitors.UDDIVisitor visitor) Visits this AccessPoint.

Methods inherited from class java.lang.Object

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

Field Detail

MAILTO

public static final java.lang.String MAILTO

Constant for specifying a MAILTO URL type.

See Also:

Constant Field Values

HTTP

public static final java.lang.String HTTP

Constant for specifying an HTTP URL type.

See Also:

Constant Field Values

HTTPS

public static final java.lang.String HTTPS

Constant for specifying an HTTPS URL type.

See Also:

Constant Field Values

FTP

public static final java.lang.String FTP

Constant for specifying an FTP URL type.

See Also:

Constant Field Values

FAX

public static final java.lang.String FAX

Constant for specifying a FAX URL type.

See Also:

Constant Field Values

PHONE

public static final java.lang.String PHONE

Constant for specifying a PHONE URL type.

See Also:

Constant Field Values

OTHER

public static final java.lang.String OTHER

Constant for specifying another URL type.

See Also:

Constant Field Values

accessPoint

protected java.lang.String accessPoint

The access point information.

urlType

protected java.lang.String urlType

The URL type.

ENDPOINT

public static final UseType ENDPOINT

AccessPoint use type 'endPoint'.

WSDLDEPLOYMENT

public static final UseType WSDLDEPLOYMENT

AccessPoint use type 'wsdlDeployment'.

BINDINGTEMPLATE

public static final UseType BINDINGTEMPLATE

AccessPoint use type 'bindingTemplate'.

HOSTINGREDIRECTOR

public static final UseType HOSTINGREDIRECTOR

AccessPoint use type 'hostingRedirector'.

useType

protected UseType useType

The use type.

Constructor Detail

AccessPoint

public AccessPoint(java.lang.String accessPoint,
                   java.lang.String urlType)

Deprecated. as of UDDI V3.0

AccessPoint constructor.

Parameters:

accessPoint - The access point information.

urlType - The URL type.

AccessPoint

public AccessPoint(java.lang.String accessPoint)

AccessPoint constructor.

Parameters:

accessPoint - The access point information.

Since:

UDDI V3.0

Method Detail

getAccessPoint

public java.lang.String getAccessPoint()

Gets the AccessPoint information.

Returns:

the AccessPoint information

setAccessPoint

public void setAccessPoint(java.lang.String accessPoint)

Sets the AccessPoint information.

Parameters:

accessPoint - The AccessPoint information.

getURLType

public java.lang.String getURLType()

Deprecated. as of UDDI V3.0

Gets the AccessPoint URL type.

Returns:

the AccessPoint URL type

setURLType

public void setURLType(java.lang.String urlType)

Deprecated. as of UDDI V3.0

Sets AccessPoint the URL type.

Parameters:

urlType - The AccessPoint URL type.

setUseType

public void setUseType(UseType useType)

Sets the AccessPoint use type.

Parameters:

useType - The use type.

Since:

UDDI V3.0

getUseType

public UseType getUseType()

Gets the AccessPoint use type.

Returns:

the use type

Since:

UDDI V3.0

visit

public java.lang.Object visit(inspireit.uddi.util.visitors.UDDIVisitor visitor)

Visits this AccessPoint.

Specified by:

visit in interface inspireit.uddi.util.visitors.UDDIElement

Parameters:

visitor - The Visitor visiting this AccessPoint.

toString

public java.lang.String toString()

Gets a string representation of this access point.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this access point

equals

public boolean equals(java.lang.Object o)

Checks whether an object is equal to this AccessPoint. Two AccessPoints are equal if their access point information are the same, whatever the URLType of useType specified.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to test for equality.

Returns:

true if o and this AccessPoint are equal; false otherwise