org.apache.marmotta.ldclient.api.endpoint

Class Endpoint

java.lang.Object

org.apache.marmotta.ldclient.api.endpoint.Endpoint

All Implemented Interfaces:

Comparable<Endpoint>

public class Endpoint
extends Object
implements Comparable<Endpoint>

Definition of a Linked Data Endpoint. Contains information how to query the endpoint, what format to expect, and when to expire data from this endpoint.

• LinkedDataProvider endpoints will be accessed by directly retrieving the URI with appropriate Accept headers following the Linked Data recommendations
• CacheProvider endpoints will be accessed by passing the URI as request parameter to the cache and parsing the response according to the content type defined for this endpoint (Content-Type header is too unspecific)
• SPARQLProvider endpoints will be accessed by issuing a query of SELECT ?p ?o WHERE { {url} ?p ?o } to retrieve all triples for the requested resource
• NONE act as blacklist. Resources matching handled by this endpoint are not fetched.

Note: this class has a natural ordering that is inconsistent with equals.

User: sschaffe

Field Summary

Fields

Modifier and Type	Field and Description
static int	PRIORITY_HIGH constant indicating high priority of this endpoint definition
static int	PRIORITY_LOW constant indicating low priority of this endpoint definition
static int	PRIORITY_MEDIUM constant indicating medium priority of this endpoint definition
static String	REGEX_INDICATOR

Constructor Summary

Constructors

Constructor and Description
Endpoint()
Endpoint(String name, String type, String uriPattern, String endpointUrl, Long defaultExpiry)
Endpoint(String name, String type, String uriPattern, String endpointUrl, String contentType, Long defaultExpiry)

Method Summary

Methods

Modifier and Type	Method and Description
void	addContentType(org.apache.marmotta.commons.http.ContentType type)
int	compareTo(Endpoint o) Compares this object with the specified object for order according to priority.
boolean	equals(Object o)
Set<org.apache.marmotta.commons.http.ContentType>	getContentTypes()
Long	getDefaultExpiry()
String	getEndpointUrl()
String	getName()
int	getPriority()
String	getProperty(String key)
String	getType()
String	getUriPattern()
Pattern	getUriPatternCompiled()
boolean	handles(String uri) Check if this Endpoint handles (is responsible) for this URI.
int	hashCode()
boolean	hasProperty(String key)
boolean	isActive()
void	setActive(boolean active)
void	setContentTypes(Set<org.apache.marmotta.commons.http.ContentType> contentTypes)
void	setDefaultExpiry(Long defaultExpiry)
void	setEndpointUrl(String endpointUrl)
void	setName(String name)
void	setPriority(int priority)
void	setProperty(String key, String value)
void	setType(String type)
void	setUriPattern(String uriPattern)

Methods inherited from class java.lang.Object

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

Field Detail

PRIORITY_HIGH

public static final int PRIORITY_HIGH

constant indicating high priority of this endpoint definition

See Also:

Constant Field Values

PRIORITY_MEDIUM

public static final int PRIORITY_MEDIUM

constant indicating medium priority of this endpoint definition

See Also:

Constant Field Values

PRIORITY_LOW

public static final int PRIORITY_LOW

constant indicating low priority of this endpoint definition

See Also:

Constant Field Values

REGEX_INDICATOR

public static final String REGEX_INDICATOR

See Also:

Constant Field Values

Constructor Detail

Endpoint

public Endpoint()

Endpoint

public Endpoint(String name,
        String type,
        String uriPattern,
        String endpointUrl,
        Long defaultExpiry)

Endpoint

public Endpoint(String name,
        String type,
        String uriPattern,
        String endpointUrl,
        String contentType,
        Long defaultExpiry)

Method Detail

getName

public String getName()

setName

public void setName(String name)

getType

public String getType()

setType

public void setType(String type)

getUriPattern

public String getUriPattern()

setUriPattern

public void setUriPattern(String uriPattern)

getEndpointUrl

public String getEndpointUrl()

setEndpointUrl

public void setEndpointUrl(String endpointUrl)

getContentTypes

public Set<org.apache.marmotta.commons.http.ContentType> getContentTypes()

addContentType

public void addContentType(org.apache.marmotta.commons.http.ContentType type)

setContentTypes

public void setContentTypes(Set<org.apache.marmotta.commons.http.ContentType> contentTypes)

getDefaultExpiry

public Long getDefaultExpiry()

setDefaultExpiry

public void setDefaultExpiry(Long defaultExpiry)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

getPriority

public int getPriority()

setPriority

public void setPriority(int priority)

hasProperty

public boolean hasProperty(String key)

getProperty

public String getProperty(String key)

setProperty

public void setProperty(String key,
               String value)

getUriPatternCompiled

public Pattern getUriPatternCompiled()

handles

public boolean handles(String uri)

Check if this Endpoint handles (is responsible) for this URI.

Parameters:

uri - the URI to check

Returns:

true if the uri matches the endpoint's uriPattern

See Also:

uriPattern

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Endpoint o)

Compares this object with the specified object for order according to priority. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface Comparable<Endpoint>

Parameters:

o - the object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

NullPointerException - if the specified object is null

ClassCastException - if the specified object's type prevents it from being compared to this object.

See Also:

getPriority()