com.exalead.mercury.mami.connect.v10

Class ScanConnector

java.lang.Object

com.exalead.mercury.mami.connect.v10.ScanConnector

All Implemented Interfaces:

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

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

Starts a scan on a connector. The scan will be performed asynchronously.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	connectorName
java.util.List<KeyValue>	keyValue
java.lang.String	scanMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ScanConnector.
static ScanConnector	fromString(java.lang.String s) String representation of this ScanConnector.
java.lang.String	getConnectorName() The name on the connector on which we want to start the scan.
java.util.List<KeyValue>	getKeyValue() Custom parameters for the scan mode.
java.lang.String	getScanMode() The mode of the scan to start
ScanConnector	makeCopy() Creates and returns a deep copy of this ScanConnector.
static ScanConnector	readFrom(java.io.InputStream is) Read this ScanConnector from an XML fragment.
void	setConnectorName(java.lang.String connectorName) The name on the connector on which we want to start the scan.
void	setScanMode(java.lang.String scanMode) The mode of the scan to start
java.lang.String	toString() String representation of this ScanConnector.
ScanConnector	withConnectorName(java.lang.String connectorName)
ScanConnector	withKeyValue(java.util.Collection<KeyValue> __values)
ScanConnector	withKeyValue(KeyValue... __values) Custom parameters for the scan mode.
ScanConnector	withScanMode(java.lang.String scanMode)
void	writeTo(java.io.OutputStream os) Write this ScanConnector as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

keyValue

public java.util.List<KeyValue> keyValue

connectorName

public java.lang.String connectorName

scanMode

public java.lang.String scanMode

Constructor Detail

ScanConnector

public ScanConnector()

ScanConnector

public ScanConnector(ScanConnector o)

Copy constructor

Method Detail

getKeyValue

public java.util.List<KeyValue> getKeyValue()

Custom parameters for the scan mode.

withKeyValue

public ScanConnector withKeyValue(KeyValue... __values)

Custom parameters for the scan mode.

withKeyValue

public ScanConnector withKeyValue(java.util.Collection<KeyValue> __values)

setConnectorName

public void setConnectorName(java.lang.String connectorName)

The name on the connector on which we want to start the scan.

getConnectorName

public java.lang.String getConnectorName()

The name on the connector on which we want to start the scan.

withConnectorName

public ScanConnector withConnectorName(java.lang.String connectorName)

setScanMode

public void setScanMode(java.lang.String scanMode)

The mode of the scan to start

getScanMode

public java.lang.String getScanMode()

The mode of the scan to start

withScanMode

public ScanConnector withScanMode(java.lang.String scanMode)

makeCopy

public ScanConnector makeCopy()

Creates and returns a deep copy of this ScanConnector.

readFrom

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

Read this ScanConnector 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 ScanConnector as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ScanConnector.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ScanConnector.

Overrides:

toString in class java.lang.Object

check

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

Checks this ScanConnector.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException