org.codice.ddf.confluence.source

Class ConfluenceSource

java.lang.Object

ddf.catalog.util.impl.DescribableImpl

ddf.catalog.util.impl.MaskableImpl

org.codice.ddf.confluence.source.ConfluenceSource

All Implemented Interfaces:

ResourceReader, ConfiguredService, ConnectedSource, FederatedSource, RemoteSource, Source, Maskable, Describable

public class ConfluenceSource
extends MaskableImpl
implements FederatedSource, ConnectedSource, ConfiguredService

Constructor Summary

Constructors

Constructor and Description
ConfluenceSource(FilterAdapter adapter, EncryptionService encryptionService, ConfluenceInputTransformer transformer, ResourceReader reader)

Method Summary

Modifier and Type	Method and Description
SecureCxfClientFactory<SearchResource>	getClientFactory()
String	getConfigurationPid() Returns the PID of the configuration that corresponds to this service
Set<ContentType>	getContentTypes() Gets the ContentTypes that are currently stored by the Source.
Set<String>	getOptions(Metacard metacard) Obtain a set of all options supported by this ResourceReader.
Set<String>	getSupportedSchemes() Returns a set of URI schemes that the ResourceReader can accept when doing a Resource lookup.
void	init()
boolean	isAvailable() This method states whether this source is available, typically connecting and performing some sort of simple query or ping to the native catalog.
boolean	isAvailable(SourceMonitor callback) This method is the same as Source.isAvailable() but allows a caller to provide a SourceMonitor callback object which is meant to be used as a way for the Source to dynamically contact the caller with its availability.
SourceResponse	query(QueryRequest request)
ResourceResponse	retrieveResource(URI uri, Map<String,Serializable> arguments) Retrieves a Resource based on a URI and provided arguments.
void	setAttributeOverrides(List<String> attributes)
void	setAvailabilityPollInterval(long availabilityPollInterval)
void	setBodyExpansion(String bodyExpansion)
void	setConfigurationPid(String configurationPid) Sets the PID of this service's corresponding configuration
void	setConfluenceSpaces(List<String> confluenceSpace)
void	setEndpointUrl(String endpointUrl)
void	setExcludeSpaces(Boolean excludeSpaces)
void	setExpandedSections(List<String> expandedSections)
void	setIncludeArchivedSpaces(Boolean includeArchivedSpaces)
void	setIncludePageContent(Boolean includePageContent)
void	setPassword(String password)
void	setUsername(String username)

Methods inherited from class ddf.catalog.util.impl.MaskableImpl

maskId, setId

Methods inherited from class ddf.catalog.util.impl.DescribableImpl

getDescription, getId, getOrganization, getTitle, getVersion, setDescription, setOrganization, setShortname, setTitle, setVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.catalog.source.Source

getSecurityAttributes

Methods inherited from interface ddf.catalog.util.Describable

getDescription, getId, getOrganization, getTitle, getVersion

Methods inherited from interface ddf.catalog.util.Maskable

maskId

Constructor Detail

ConfluenceSource

public ConfluenceSource(FilterAdapter adapter,
                        EncryptionService encryptionService,
                        ConfluenceInputTransformer transformer,
                        ResourceReader reader)

Method Detail

init

public void init()

getConfigurationPid

public String getConfigurationPid()

Description copied from interface: ConfiguredService

Returns the PID of the configuration that corresponds to this service

Specified by:

getConfigurationPid in interface ConfiguredService

Returns:

The unique PID of the configuration associated with this service

setConfigurationPid

public void setConfigurationPid(String configurationPid)

Description copied from interface: ConfiguredService

Sets the PID of this service's corresponding configuration

Specified by:

setConfigurationPid in interface ConfiguredService

Parameters:

configurationPid - The unique PID of the configuration associated with this service

isAvailable

public boolean isAvailable()

Description copied from interface: Source

This method states whether this source is available, typically connecting and performing some sort of simple query or ping to the native catalog.

This is expected to be an expensive operation, possibly involving network I/O. Typically only CatalogFramework implementations will call this and only periodically.

Specified by:

isAvailable in interface Source

Returns:

true - if the site is available (up), false - if the site is unavailable (down)

See Also:

ddf.catalog.util.SourcePoller

isAvailable

public boolean isAvailable(SourceMonitor callback)

Description copied from interface: Source

This method is the same as Source.isAvailable() but allows a caller to provide a SourceMonitor callback object which is meant to be used as a way for the Source to dynamically contact the caller with its availability. The intent is to return a boolean as to whether the Source is available at this very moment and also to use the SourceMonitor object to update the caller of this method if this Source's availability changes later in the future.

Specified by:

isAvailable in interface Source

Parameters:

callback - - used to notify the caller of this method when the Source object wants to update its availability.

Returns:

true - if the site is available (up), false - if the site is unavailable (down)

query

public SourceResponse query(QueryRequest request)
                     throws UnsupportedQueryException

Specified by:

query in interface Source

Parameters:

request - the query to execute

Returns:

a SourceResponse with query results and query response details

Throws:

UnsupportedQueryException - when the query is not understood, malformed, or not supported by a Source

getContentTypes

public Set<ContentType> getContentTypes()

Description copied from interface: Source

Gets the ContentTypes that are currently stored by the Source. Notice the return object is a Set, meaning it returns all unique content types found in the Source without duplications.

Specified by:

getContentTypes in interface Source

Returns:

a Set of ContentTypes currently available from this Source.

retrieveResource

public ResourceResponse retrieveResource(URI uri,
                                         Map<String,Serializable> arguments)
                                  throws IOException,
                                         ResourceNotFoundException,
                                         ResourceNotSupportedException

Description copied from interface: ResourceReader

Retrieves a Resource based on a URI and provided arguments.

Specified by:

retrieveResource in interface ResourceReader

Parameters:

uri - A URI that defines what Resource to retrieve and how to do it.

arguments - Any additional arguments that should be passed to the ResourceReader.

Returns:

A ResourceResponse containing the retrieved Resource.

Throws:

IOException

ResourceNotFoundException

ResourceNotSupportedException

getSupportedSchemes

public Set<String> getSupportedSchemes()

Description copied from interface: ResourceReader

Returns a set of URI schemes that the ResourceReader can accept when doing a Resource lookup. Custom schemes can be created for a ResourceReader to support.

Specified by:

getSupportedSchemes in interface ResourceReader

Returns:

Set of supported schemes

getOptions

public Set<String> getOptions(Metacard metacard)

Description copied from interface: ResourceReader

Obtain a set of all options supported by this ResourceReader. Options are used to obtain the Resource in a unique way.

Specified by:

getOptions in interface ResourceReader

Returns:

Set of all options that this ResourceReader supports. This will be an empty set if no options are supported.

setAvailabilityPollInterval

public void setAvailabilityPollInterval(long availabilityPollInterval)

setEndpointUrl

public void setEndpointUrl(String endpointUrl)

setUsername

public void setUsername(String username)

setPassword

public void setPassword(String password)

setExpandedSections

public void setExpandedSections(List<String> expandedSections)

setIncludeArchivedSpaces

public void setIncludeArchivedSpaces(Boolean includeArchivedSpaces)

setIncludePageContent

public void setIncludePageContent(Boolean includePageContent)

setConfluenceSpaces

public void setConfluenceSpaces(List<String> confluenceSpace)

setExcludeSpaces

public void setExcludeSpaces(Boolean excludeSpaces)

setAttributeOverrides

public void setAttributeOverrides(List<String> attributes)

setBodyExpansion

public void setBodyExpansion(String bodyExpansion)

getClientFactory

public SecureCxfClientFactory<SearchResource> getClientFactory()