com.exalead.mercury.mami.connect.v10

Class IntrospectConnector

java.lang.Object

com.exalead.mercury.mami.connect.v10.IntrospectConnector

All Implemented Interfaces:

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

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

Performs an introspection query on a connector server.
The connector does not need to be deployed.
Functional definition of each introspection query is connector-specific.
This method uses the supplied connector configuration for the introspection call.
Depending on the introspection query, the config might has to be fully valid or not. Returns the introspection result as a KeyValue tree

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntrospectConnector.ConnectorConfig
static class	IntrospectConnector.IntrospectionQueryParams
static class	IntrospectConnector.ScanModeConfig

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	connectorClassId
protected IntrospectConnector.ConnectorConfig	connectorConfig
java.lang.String	connectorServer
java.lang.String	introspectionQueryClassId
protected IntrospectConnector.IntrospectionQueryParams	introspectionQueryParams
java.lang.String	scanMode
protected IntrospectConnector.ScanModeConfig	scanModeConfig

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this IntrospectConnector.
static IntrospectConnector	fromString(java.lang.String s) String representation of this IntrospectConnector.
java.lang.String	getConnectorClassId()
IntrospectConnector.ConnectorConfig	getConnectorConfig()
java.lang.String	getConnectorServer()
java.lang.String	getIntrospectionQueryClassId()
IntrospectConnector.IntrospectionQueryParams	getIntrospectionQueryParams()
java.lang.String	getScanMode() Specifies the scan mode when the introspection query is fired by a custom scan mode.
IntrospectConnector.ScanModeConfig	getScanModeConfig()
IntrospectConnector	makeCopy() Creates and returns a deep copy of this IntrospectConnector.
static IntrospectConnector	readFrom(java.io.InputStream is) Read this IntrospectConnector from an XML fragment.
void	setConnectorClassId(java.lang.String connectorClassId)
void	setConnectorConfig(IntrospectConnector.ConnectorConfig __value)
void	setConnectorServer(java.lang.String connectorServer)
void	setIntrospectionQueryClassId(java.lang.String introspectionQueryClassId)
void	setIntrospectionQueryParams(IntrospectConnector.IntrospectionQueryParams __value)
void	setScanMode(java.lang.String scanMode) Specifies the scan mode when the introspection query is fired by a custom scan mode.
void	setScanModeConfig(IntrospectConnector.ScanModeConfig __value)
java.lang.String	toString() String representation of this IntrospectConnector.
IntrospectConnector	withConnectorClassId(java.lang.String connectorClassId)
IntrospectConnector	withConnectorConfig(java.util.Collection<KeyValue> __values)
IntrospectConnector	withConnectorConfig(IntrospectConnector.ConnectorConfig __value)
IntrospectConnector	withConnectorConfig(KeyValue... __values)
IntrospectConnector	withConnectorServer(java.lang.String connectorServer)
IntrospectConnector	withIntrospectionQueryClassId(java.lang.String introspectionQueryClassId)
IntrospectConnector	withIntrospectionQueryParams(java.util.Collection<KeyValue> __values)
IntrospectConnector	withIntrospectionQueryParams(IntrospectConnector.IntrospectionQueryParams __value)
IntrospectConnector	withIntrospectionQueryParams(KeyValue... __values)
IntrospectConnector	withScanMode(java.lang.String scanMode)
IntrospectConnector	withScanModeConfig(java.util.Collection<KeyValue> __values)
IntrospectConnector	withScanModeConfig(IntrospectConnector.ScanModeConfig __value)
IntrospectConnector	withScanModeConfig(KeyValue... __values)
void	writeTo(java.io.OutputStream os) Write this IntrospectConnector as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

connectorServer

public java.lang.String connectorServer

connectorClassId

public java.lang.String connectorClassId

introspectionQueryClassId

public java.lang.String introspectionQueryClassId

introspectionQueryParams

protected IntrospectConnector.IntrospectionQueryParams introspectionQueryParams

connectorConfig

protected IntrospectConnector.ConnectorConfig connectorConfig

scanMode

public java.lang.String scanMode

scanModeConfig

protected IntrospectConnector.ScanModeConfig scanModeConfig

Constructor Detail

IntrospectConnector

public IntrospectConnector()

IntrospectConnector

public IntrospectConnector(IntrospectConnector o)

Copy constructor

Method Detail

setConnectorServer

public void setConnectorServer(java.lang.String connectorServer)

getConnectorServer

public java.lang.String getConnectorServer()

withConnectorServer

public IntrospectConnector withConnectorServer(java.lang.String connectorServer)

setConnectorClassId

public void setConnectorClassId(java.lang.String connectorClassId)

getConnectorClassId

public java.lang.String getConnectorClassId()

withConnectorClassId

public IntrospectConnector withConnectorClassId(java.lang.String connectorClassId)

setIntrospectionQueryClassId

public void setIntrospectionQueryClassId(java.lang.String introspectionQueryClassId)

getIntrospectionQueryClassId

public java.lang.String getIntrospectionQueryClassId()

withIntrospectionQueryClassId

public IntrospectConnector withIntrospectionQueryClassId(java.lang.String introspectionQueryClassId)

getIntrospectionQueryParams

public IntrospectConnector.IntrospectionQueryParams getIntrospectionQueryParams()

setIntrospectionQueryParams

public void setIntrospectionQueryParams(IntrospectConnector.IntrospectionQueryParams __value)

withIntrospectionQueryParams

public IntrospectConnector withIntrospectionQueryParams(KeyValue... __values)

withIntrospectionQueryParams

public IntrospectConnector withIntrospectionQueryParams(java.util.Collection<KeyValue> __values)

withIntrospectionQueryParams

public IntrospectConnector withIntrospectionQueryParams(IntrospectConnector.IntrospectionQueryParams __value)

getConnectorConfig

public IntrospectConnector.ConnectorConfig getConnectorConfig()

setConnectorConfig

public void setConnectorConfig(IntrospectConnector.ConnectorConfig __value)

withConnectorConfig

public IntrospectConnector withConnectorConfig(KeyValue... __values)

withConnectorConfig

public IntrospectConnector withConnectorConfig(java.util.Collection<KeyValue> __values)

withConnectorConfig

public IntrospectConnector withConnectorConfig(IntrospectConnector.ConnectorConfig __value)

setScanMode

public void setScanMode(java.lang.String scanMode)

Specifies the scan mode when the introspection query is fired by a custom scan mode.

getScanMode

public java.lang.String getScanMode()

Specifies the scan mode when the introspection query is fired by a custom scan mode.

withScanMode

public IntrospectConnector withScanMode(java.lang.String scanMode)

getScanModeConfig

public IntrospectConnector.ScanModeConfig getScanModeConfig()

setScanModeConfig

public void setScanModeConfig(IntrospectConnector.ScanModeConfig __value)

withScanModeConfig

public IntrospectConnector withScanModeConfig(KeyValue... __values)

withScanModeConfig

public IntrospectConnector withScanModeConfig(java.util.Collection<KeyValue> __values)

withScanModeConfig

public IntrospectConnector withScanModeConfig(IntrospectConnector.ScanModeConfig __value)

makeCopy

public IntrospectConnector makeCopy()

Creates and returns a deep copy of this IntrospectConnector.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this IntrospectConnector.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this IntrospectConnector.

Overrides:

toString in class java.lang.Object

check

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

Checks this IntrospectConnector.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException