Package org.ivoa.dm.regtap

Class Interface.InterfaceBuilder

java.lang.Object

org.ivoa.dm.regtap.Interface.InterfaceBuilder

Enclosing class:

Interface

public static class Interface.InterfaceBuilder
extends Object

A builder class for Interface, mainly for use in the functional builder pattern.

Field Summary

Fields

Modifier and Type	Field	Description
String	access_url	The URL at which the interface is found.
Integer	authenticated_only	A flag for whether an interface is available for anonymous use (=0) or only authenticated clients are served (=1).
Integer	cap_index	The index of the parent capability.
Integer	intf_index	An arbitrary identifier for the interfaces of a resource.
String	intf_role	An identifier for the role the interface plays in the particular capability.
String	intf_type	The type of the interface (vr:webbrowser, vs:paramhttp, etc).
String	mirror_url	Secondary access URLs of this interface, separated by hash characters.
String	query_type	Hash-joined list of expected HTTP method (get or post) supported by the service.
String	result_type	The MIME type of a document returned in the HTTP response.
String	std_version	The version of a standard interface specification that this interface complies with.
String	url_use	A flag indicating whether this should be interpreted as a base URL ('base'), a full URL ('full'), or a URL to a directory that will produce a listing of files ('dir').
String	wsdl_url	The location of the WSDL that describes this Web Service.

Constructor Summary

Constructors

Constructor	Description
InterfaceBuilder()

Method Summary

Modifier and Type	Method	Description
Interface	create()	create a Interface from this builder.

Methods inherited from class java.lang.Object

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

Field Details

cap_index

public Integer cap_index

The index of the parent capability.

intf_index

public Integer intf_index

An arbitrary identifier for the interfaces of a resource.

intf_type

public String intf_type

The type of the interface (vr:webbrowser, vs:paramhttp, etc).

intf_role

public String intf_role

An identifier for the role the interface plays in the particular capability. If the value is equal to 'std' or begins with 'std:', then the interface refers to a standard interface defined by the standard referred to by the capability's standardID attribute.

std_version

public String std_version

The version of a standard interface specification that this interface complies with. When the interface is provided in the context of a Capability element, then the standard being refered to is the one identified by the Capability's standardID element.

query_type

public String query_type

Hash-joined list of expected HTTP method (get or post) supported by the service.

result_type

public String result_type

The MIME type of a document returned in the HTTP response.

wsdl_url

public String wsdl_url

The location of the WSDL that describes this Web Service. If NULL, the location can be assumed to be the accessURL with '?wsdl' appended.

url_use

public String url_use

A flag indicating whether this should be interpreted as a base URL ('base'), a full URL ('full'), or a URL to a directory that will produce a listing of files ('dir').

access_url

public String access_url

The URL at which the interface is found.

mirror_url

public String mirror_url

Secondary access URLs of this interface, separated by hash characters.

authenticated_only

public Integer authenticated_only

A flag for whether an interface is available for anonymous use (=0) or only authenticated clients are served (=1).

Constructor Details

InterfaceBuilder

public InterfaceBuilder()

Method Details

create

public Interface create()

create a Interface from this builder.

Returns:

an object initialized from the builder.