public class ConfluenceSource extends MaskableImpl implements FederatedSource, ConnectedSource, ConfiguredService
Constructor and Description |
---|
ConfluenceSource(FilterAdapter adapter,
EncryptionService encryptionService,
ConfluenceInputTransformer transformer,
ResourceReader reader) |
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
ContentType s 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()
|
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)
|
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) |
maskId, setId
getDescription, getId, getOrganization, getTitle, getVersion, setDescription, setOrganization, setShortname, setTitle, setVersion
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getSecurityAttributes
getDescription, getId, getOrganization, getTitle, getVersion
public ConfluenceSource(FilterAdapter adapter, EncryptionService encryptionService, ConfluenceInputTransformer transformer, ResourceReader reader)
public void init()
public String getConfigurationPid()
ConfiguredService
getConfigurationPid
in interface ConfiguredService
public void setConfigurationPid(String configurationPid)
ConfiguredService
setConfigurationPid
in interface ConfiguredService
configurationPid
- The unique PID of the configuration associated with this servicepublic boolean isAvailable()
Source
This is expected to be an expensive operation, possibly involving network I/O.
Typically only CatalogFramework
implementations will call this and only
periodically.
isAvailable
in interface Source
ddf.catalog.util.SourcePoller
public boolean isAvailable(SourceMonitor callback)
Source
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.isAvailable
in interface Source
callback
- - used to notify the caller of this method when the Source
object wants
to update its availability.public SourceResponse query(QueryRequest request) throws UnsupportedQueryException
query
in interface Source
request
- the query to executeSourceResponse
with query results and query response detailsUnsupportedQueryException
- when the query is not understood, malformed, or not supported
by a Source
public Set<ContentType> getContentTypes()
Source
ContentType
s 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.getContentTypes
in interface Source
Set
of ContentType
s currently available from this Source
.public ResourceResponse retrieveResource(URI uri, Map<String,Serializable> arguments) throws IOException, ResourceNotFoundException, ResourceNotSupportedException
ResourceReader
retrieveResource
in interface ResourceReader
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.ResourceResponse
containing the retrieved Resource
.IOException
ResourceNotFoundException
ResourceNotSupportedException
public Set<String> getSupportedSchemes()
ResourceReader
URI
schemes that the ResourceReader can accept when doing a Resource
lookup. Custom schemes can be created for a ResourceReader to support.getSupportedSchemes
in interface ResourceReader
Set
of supported schemespublic Set<String> getOptions(Metacard metacard)
ResourceReader
Resource
in a unique way.getOptions
in interface ResourceReader
Set
of all options that this ResourceReader supports. This will be an empty set
if no options are supported.public void setAvailabilityPollInterval(long availabilityPollInterval)
public void setEndpointUrl(String endpointUrl)
public void setUsername(String username)
public void setPassword(String password)
public void setIncludeArchivedSpaces(Boolean includeArchivedSpaces)
public void setIncludePageContent(Boolean includePageContent)
public void setExcludeSpaces(Boolean excludeSpaces)
public void setBodyExpansion(String bodyExpansion)
public SecureCxfClientFactory<SearchResource> getClientFactory()
This work is licensed under a Creative Commons Attribution 4.0 International License.