org.fcrepo.camel

Class FcrepoEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.fcrepo.camel.FcrepoEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@ManagedResource(description="Managed FcrepoEndpoint")
 @UriEndpoint(scheme="fcrepo",
             title="Fedora Commons Repository",
             syntax="fcrepo:host:port/path")
public class FcrepoEndpoint
extends org.apache.camel.impl.DefaultEndpoint

Represents a Fcrepo endpoint.

Since:

October 20, 2014

Author:

Aaron Coburn

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HTTPS_PORT

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
FcrepoEndpoint(String uri, String remaining, FcrepoComponent component, FcrepoConfiguration configuration) Create a FcrepoEndpoint with a uri, path and component

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor) This component does not implement a consumer endpoint.
org.apache.camel.Producer	createProducer() Create a producer endpoint.
org.springframework.transaction.support.TransactionTemplate	createTransactionTemplate() Create a template for use in transactions
String	getAccept() accept getter
String	getAuthHost() authHost getter
String	getAuthPassword() authPassword getter
String	getAuthUsername() authUsername getter
String	getBaseUrl() baseUrl getter
String	getBaseUrlWithScheme() Get the repository baseUrl with a full scheme.
FcrepoConfiguration	getConfiguration() configuration getter
String	getContentType() contentType getter
Boolean	getFixity() fixity getter
Boolean	getMetadata() metadata getter
String	getPreferInclude() preferInclude getter
String	getPreferOmit() preferOmit getter
Boolean	getThrowExceptionOnFailure() throwExceptionOnFailure getter
org.springframework.transaction.PlatformTransactionManager	getTransactionManager() transactionManager getter
boolean	isSingleton() Define the component as a singleton
void	setAccept(String type) accept setter
void	setAuthHost(String host) authHost setter
void	setAuthPassword(String password) authPassword setter
void	setAuthUsername(String username) authUsername setter
void	setBaseUrl(String url) baseUrl setter
void	setConfiguration(FcrepoConfiguration config) configuration setter
void	setContentType(String type) contentType setter
void	setFixity(Boolean fixity) fixity setter
void	setMetadata(Boolean metadata) metadata setter
void	setPreferInclude(String include) preferInclude setter
void	setPreferOmit(String omit) preferOmit setter
void	setThrowExceptionOnFailure(Boolean throwOnFailure) throwExceptionOnFailure setter
void	setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager) transactionManager setter

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.Service

start, stop

Field Detail

DEFAULT_HTTPS_PORT

public static final int DEFAULT_HTTPS_PORT

See Also:

Constant Field Values

Constructor Detail

FcrepoEndpoint

public FcrepoEndpoint(String uri,
                      String remaining,
                      FcrepoComponent component,
                      FcrepoConfiguration configuration)

Create a FcrepoEndpoint with a uri, path and component

Parameters:

uri - the endpoint uri (without path values)

remaining - any path values on the endpoint uri

component - an existing component value

configuration - configuration settings for this endpoint

Method Detail

createProducer

public org.apache.camel.Producer createProducer()

Create a producer endpoint.

Returns:

A new camel producer endpoint

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)

This component does not implement a consumer endpoint.

isSingleton

public boolean isSingleton()

Define the component as a singleton

Returns:

whether the endpoint is implemented as a singleton.

createTransactionTemplate

public org.springframework.transaction.support.TransactionTemplate createTransactionTemplate()

Create a template for use in transactions

Returns:

a transaction template

getBaseUrlWithScheme

public String getBaseUrlWithScheme()

Get the repository baseUrl with a full scheme. The base URL may be any of the following: localhost:8080/rest fedora.institution.org:8983/rest http://localhost:8080/fcrepo/rest https://fedora.institution.org/rest fedora.insitution.org:443/rest This method ensures that the url (fragment) is properly prefixed with either the http or https scheme, suitable for sending to the httpclient.

Returns:

String

getConfiguration

public FcrepoConfiguration getConfiguration()

configuration getter

Returns:

the component configuration

setConfiguration

public void setConfiguration(FcrepoConfiguration config)

configuration setter

Parameters:

config - The FcrepoConfiguration

setBaseUrl

public void setBaseUrl(String url)

baseUrl setter

Parameters:

url - the fcrepo base url

getBaseUrl

public String getBaseUrl()

baseUrl getter

Returns:

the fcrepo base url

setTransactionManager

@ManagedAttribute(description="Transaction Manager")
public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

transactionManager setter

Parameters:

transactionManager - the transaction manager for this endpoint

getTransactionManager

@ManagedAttribute(description="Transaction Manager")
public org.springframework.transaction.PlatformTransactionManager getTransactionManager()

transactionManager getter

Returns:

the transaction manager for this endpoint

setAccept

@ManagedAttribute(description="Accept: Header")
public void setAccept(String type)

accept setter

Parameters:

type - the mime-type used with Accept headers

getAccept

@ManagedAttribute(description="Accept: Header")
public String getAccept()

accept getter

Returns:

the mime-type used with Accept headers

setContentType

@ManagedAttribute(description="Content-Type: Header")
public void setContentType(String type)

contentType setter

Parameters:

type - the mime-type used with Content-Type headers

getContentType

@ManagedAttribute(description="Content-Type: Header")
public String getContentType()

contentType getter

Returns:

the mime-type used with Content-Type headers

setAuthUsername

@ManagedAttribute(description="Username for authentication")
public void setAuthUsername(String username)

authUsername setter

Parameters:

username - used for repository authentication

getAuthUsername

@ManagedAttribute(description="Username for authentication")
public String getAuthUsername()

authUsername getter

Returns:

the username used for repository authentication

setAuthPassword

@ManagedAttribute(description="Password for authentication")
public void setAuthPassword(String password)

authPassword setter

Parameters:

password - used for repository authentication

getAuthPassword

@ManagedAttribute(description="Password for authentication")
public String getAuthPassword()

authPassword getter

Returns:

the password used for repository authentication

setAuthHost

@ManagedAttribute(description="Hostname for authentication")
public void setAuthHost(String host)

authHost setter

Parameters:

host - realm used for repository authentication

getAuthHost

@ManagedAttribute(description="Hostname for authentication")
public String getAuthHost()

authHost getter

Returns:

the host realm used for repository authentication

setMetadata

@ManagedAttribute(description="Whether to retrieve the /fcr:metadata endpoint for Binary nodes")
public void setMetadata(Boolean metadata)

metadata setter

Parameters:

metadata - whether to retrieve rdf metadata for non-rdf nodes

getMetadata

@ManagedAttribute(description="Whether to retrieve the /fcr:metadata endpoint for Binary nodes")
public Boolean getMetadata()

metadata getter

Returns:

whether to retrieve rdf metadata for non-rdf nodes

setThrowExceptionOnFailure

@ManagedAttribute(description="Whether HTTP response errors should throw an exception")
public void setThrowExceptionOnFailure(Boolean throwOnFailure)

throwExceptionOnFailure setter

Parameters:

throwOnFailure - whether HTTP error codes throw exceptions

getThrowExceptionOnFailure

@ManagedAttribute(description="Whether HTTP response errors should throw an exception")
public Boolean getThrowExceptionOnFailure()

throwExceptionOnFailure getter

Returns:

whether HTTP error codes throw exceptions

setFixity

@ManagedAttribute(description="Whether to access the /fcr:fixity endpoint for a resource")
public void setFixity(Boolean fixity)

fixity setter

Parameters:

fixity - whether to access the /fcr:fixity endpoint for a resource

getFixity

@ManagedAttribute(description="Whether to access the /fcr:fixity endpoint for a resource")
public Boolean getFixity()

fixity getter

Returns:

whether to access the /fcr:fixity endpoint for a resource

setPreferInclude

@ManagedAttribute(description="Whether to include a Prefer: return=representation; include=\"URI\" header")
public void setPreferInclude(String include)

preferInclude setter

Parameters:

include - the URI(s) that populate the include section in a Prefer header

getPreferInclude

@ManagedAttribute(description="Whether to include a Prefer: return=representation; include=\"URI\" header")
public String getPreferInclude()

preferInclude getter

Returns:

the URI(s) that populate the include section in a Prefer header

setPreferOmit

@ManagedAttribute(description="Whether to include a Prefer: return=representation; omit=\"URI\" header")
public void setPreferOmit(String omit)

preferOmit setter

Parameters:

omit - the URI(s) that populate the omit section in a Prefer header

getPreferOmit

@ManagedAttribute(description="Whether to include a Prefer: return=representation; omit=\"URI\" header")
public String getPreferOmit()

preferOmit getter

Returns:

the URI(s) that populate the omit section in a Prefer header