com.exalead.mercury.mami.connect.v10

Class ConnectorCapabilities

java.lang.Object

com.exalead.mercury.mami.connect.v10.ConnectorCapabilities

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ConnectorCapabilities
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Capabilities of a connector

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<ConnectorScanMode>	connectorScanMode
java.lang.String	workflow

Constructor Summary

Constructors

Constructor and Description
ConnectorCapabilities()
ConnectorCapabilities(ConnectorCapabilities o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ConnectorCapabilities.
static ConnectorCapabilities	fromString(java.lang.String s) String representation of this ConnectorCapabilities.
java.util.List<ConnectorScanMode>	getConnectorScanMode() List of scan modes of the connector.
java.lang.String	getWorkflow() Specifies how the connector operates: scan-based: launches successive "scans" of the data source. permanent-work: scan is triggered once and the connector then listens to events.
ConnectorCapabilities	makeCopy() Creates and returns a deep copy of this ConnectorCapabilities.
static ConnectorCapabilities	readFrom(java.io.InputStream is) Read this ConnectorCapabilities from an XML fragment.
void	setWorkflow(java.lang.String workflow) Specifies how the connector operates: scan-based: launches successive "scans" of the data source. permanent-work: scan is triggered once and the connector then listens to events.
java.lang.String	toString() String representation of this ConnectorCapabilities.
ConnectorCapabilities	withConnectorScanMode(java.util.Collection<ConnectorScanMode> __values)
ConnectorCapabilities	withConnectorScanMode(ConnectorScanMode... __values) List of scan modes of the connector.
ConnectorCapabilities	withWorkflow(java.lang.String workflow)
void	writeTo(java.io.OutputStream os) Write this ConnectorCapabilities as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

workflow

public java.lang.String workflow

connectorScanMode

public java.util.List<ConnectorScanMode> connectorScanMode

Constructor Detail

ConnectorCapabilities

public ConnectorCapabilities()

ConnectorCapabilities

public ConnectorCapabilities(ConnectorCapabilities o)

Copy constructor

Method Detail

setWorkflow

public void setWorkflow(java.lang.String workflow)

Specifies how the connector operates:

• scan-based: launches successive "scans" of the data source.
• permanent-work: scan is triggered once and the connector then listens to events.

getWorkflow

public java.lang.String getWorkflow()

Specifies how the connector operates:

• scan-based: launches successive "scans" of the data source.
• permanent-work: scan is triggered once and the connector then listens to events.

withWorkflow

public ConnectorCapabilities withWorkflow(java.lang.String workflow)

getConnectorScanMode

public java.util.List<ConnectorScanMode> getConnectorScanMode()

List of scan modes of the connector.

withConnectorScanMode

public ConnectorCapabilities withConnectorScanMode(ConnectorScanMode... __values)

List of scan modes of the connector.

withConnectorScanMode

public ConnectorCapabilities withConnectorScanMode(java.util.Collection<ConnectorScanMode> __values)

makeCopy

public ConnectorCapabilities makeCopy()

Creates and returns a deep copy of this ConnectorCapabilities.

readFrom

public static ConnectorCapabilities readFrom(java.io.InputStream is)
                                      throws javax.xml.bind.JAXBException

Read this ConnectorCapabilities from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ConnectorCapabilities as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ConnectorCapabilities fromString(java.lang.String s)
                                        throws javax.xml.bind.JAXBException,
                                               java.io.UnsupportedEncodingException

String representation of this ConnectorCapabilities.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ConnectorCapabilities.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ConnectorCapabilities.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException