Connector (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.mercury.mami.connect.v10.Connector

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class Connector
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
The configuration of a connector

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Connector.AuthenticationMode

static class Connector.Config

static class Connector.ForcedMeta

Nested Classes
Modifier and Type	Class and Description
`static class`	`Connector.AuthenticationMode`
`static class`	`Connector.Config`
`static class`	`Connector.ForcedMeta`

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`authenticationMode`
`java.lang.String`	`buildGroup` Deprecated.
`java.lang.String`	`classId`
`protected Connector.Config`	`config`
`java.util.List<ConnectorScheduledScan>`	`connectorScheduledScan`
`java.lang.String`	`connectorServer`
`java.lang.String`	`customClassId`
`static java.lang.String`	`DEFAULT_AUTHENTICATION_MODE`
`static boolean`	`DEFAULT_GENERATED`
`static boolean`	`DEFAULT_MANAGED`
`java.lang.String`	`defaultDataModelClass`
`java.lang.String`	`documentsType`
`protected Connector.ForcedMeta`	`forcedMeta`
`boolean`	`generated`
`java.lang.String`	`login`
`boolean`	`managed`
`java.lang.String`	`name`
`java.lang.String`	`password`
`PostProcessingPipeline`	`postProcessingPipeline`
`java.lang.String`	`pushAPIServer`
`PushConfig`	`pushConfig`
`SourceCachingConfig`	`sourceCachingConfig`
`SourceFetchConfig`	`sourceFetchConfig`
`SourcePreviewConfig`	`sourcePreviewConfig`
`SourceThumbnailsConfig`	`sourceThumbnailsConfig`

Constructor Summary

Constructors
Constructor and Description

Connector()

Connector(Connector o)
Copy constructor

Constructors
Constructor and Description
`Connector()`
`Connector(Connector o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this Connector.
`static Connector`	`fromString(java.lang.String s)` String representation of this Connector.
`java.lang.String`	`getAuthenticationMode()` The connector configuration parameters. Connector parameters such as the data sources or folders to actually index in the data source are provided as key-values. No configuration parameters should be provided for unmanaged connectors. The set of meta data to be automatically added to indexed documents.
`Connector.AuthenticationMode`	`getAuthenticationModeAsEnum()` The connector configuration parameters. Connector parameters such as the data sources or folders to actually index in the data source are provided as key-values. No configuration parameters should be provided for unmanaged connectors. The set of meta data to be automatically added to indexed documents.
`java.lang.String`	`getBuildGroup()` Deprecated.
`java.lang.String`	`getClassId()` Connector class identifier. This identifies the kind of data source this connectors connects to, as well as the actual implementation. The class identifier can be a reference to an exascript class, a Java class or a .NET Class. This attribute must be null for unmanaged connectors. The value provided should be one of the values returned by
`Connector.Config`	`getConfig()`
`java.util.List<ConnectorScheduledScan>`	`getConnectorScheduledScan()` List of scheduled scans for the connector.
`java.lang.String`	`getConnectorServer()` Defines the connector server hosting this connector. For managed connectors only.
`java.lang.String`	`getCustomClassId()` Implementation class identifier. Optional. Can be used to specify a custom implementation of the connector.
`java.lang.String`	`getDefaultDataModelClass()` Specifies the class in which the documents should be indexed if the connector does not provide a dataModelClass indication for its documents. The default value (null) means that the documents will go in the default class of the DataModel.
`java.lang.String`	`getDocumentsType()` Type of documents produced by this source. The type of documents must match one of the types declared in your CloudView license file.
`Connector.ForcedMeta`	`getForcedMeta()`
`java.lang.String`	`getLogin()` User login if `authenticationMode` parameter is set to `basic`.
`java.lang.String`	`getName()` The name of the connector.
`java.lang.String`	`getPassword()` User password if `authenticationMode` parameter is set to `basic`.
`PostProcessingPipeline`	`getPostProcessingPipeline()` Pipeline post-processing documents sent by this connector.
`java.lang.String`	`getPushAPIServer()` Defines the Push API server that will receive the documents. For managed connectors only.
`PushConfig`	`getPushConfig()` Specifies how documents are sent to the indexing-server.
`SourceCachingConfig`	`getSourceCachingConfig()`
`SourceFetchConfig`	`getSourceFetchConfig()`
`SourcePreviewConfig`	`getSourcePreviewConfig()`
`SourceThumbnailsConfig`	`getSourceThumbnailsConfig()`
`static boolean`	`isA(java.lang.String str, Connector.AuthenticationMode item)`
`boolean`	`isGenerated()` Has this connector been generated automatically by another component or it has been manually added by the user. A generated connector must be configured by the component that has generated it and won't be editable in admin-ui
`boolean`	`isManaged()` Indicates that the connector is managed by a framework. A managed connector is launched and operated as a CloudView service, whereas an 'unmanaged connector' is handled by a third-party process.
`static boolean`	`isOneOf(java.lang.String str, Connector.AuthenticationMode... items)`
`Connector`	`makeCopy()` Creates and returns a deep copy of this Connector.
`static Connector`	`readFrom(java.io.InputStream is)` Read this Connector from an XML fragment.
`void`	`setAuthenticationMode(Connector.AuthenticationMode item)` The connector configuration parameters. Connector parameters such as the data sources or folders to actually index in the data source are provided as key-values. No configuration parameters should be provided for unmanaged connectors. The set of meta data to be automatically added to indexed documents.
`void`	`setAuthenticationMode(java.lang.String authenticationMode)` The connector configuration parameters. Connector parameters such as the data sources or folders to actually index in the data source are provided as key-values. No configuration parameters should be provided for unmanaged connectors. The set of meta data to be automatically added to indexed documents.
`void`	`setBuildGroup(java.lang.String buildGroup)` Deprecated.
`void`	`setClassId(java.lang.String classId)` Connector class identifier. This identifies the kind of data source this connectors connects to, as well as the actual implementation. The class identifier can be a reference to an exascript class, a Java class or a .NET Class. This attribute must be null for unmanaged connectors. The value provided should be one of the values returned by
`void`	`setConfig(Connector.Config __value)`
`void`	`setConnectorServer(java.lang.String connectorServer)` Defines the connector server hosting this connector. For managed connectors only.
`void`	`setCustomClassId(java.lang.String customClassId)` Implementation class identifier. Optional. Can be used to specify a custom implementation of the connector.
`void`	`setDefaultDataModelClass(java.lang.String defaultDataModelClass)` Specifies the class in which the documents should be indexed if the connector does not provide a dataModelClass indication for its documents. The default value (null) means that the documents will go in the default class of the DataModel.
`void`	`setDocumentsType(java.lang.String documentsType)` Type of documents produced by this source. The type of documents must match one of the types declared in your CloudView license file.
`void`	`setForcedMeta(Connector.ForcedMeta __value)`
`void`	`setGenerated(boolean generated)` Has this connector been generated automatically by another component or it has been manually added by the user. A generated connector must be configured by the component that has generated it and won't be editable in admin-ui
`void`	`setLogin(java.lang.String login)` User login if `authenticationMode` parameter is set to `basic`.
`void`	`setManaged(boolean managed)` Indicates that the connector is managed by a framework. A managed connector is launched and operated as a CloudView service, whereas an 'unmanaged connector' is handled by a third-party process.
`void`	`setName(java.lang.String name)` The name of the connector.
`void`	`setPassword(java.lang.String password)` User password if `authenticationMode` parameter is set to `basic`.
`void`	`setPostProcessingPipeline(PostProcessingPipeline postProcessingPipeline)` Pipeline post-processing documents sent by this connector.
`void`	`setPushAPIServer(java.lang.String pushAPIServer)` Defines the Push API server that will receive the documents. For managed connectors only.
`void`	`setPushConfig(PushConfig pushConfig)` Specifies how documents are sent to the indexing-server.
`void`	`setSourceCachingConfig(SourceCachingConfig sourceCachingConfig)`
`void`	`setSourceFetchConfig(SourceFetchConfig sourceFetchConfig)`
`void`	`setSourcePreviewConfig(SourcePreviewConfig sourcePreviewConfig)`
`void`	`setSourceThumbnailsConfig(SourceThumbnailsConfig sourceThumbnailsConfig)`
`java.lang.String`	`toString()` String representation of this Connector.
`Connector`	`withAuthenticationMode(java.lang.String authenticationMode)`
`Connector`	`withBuildGroup(java.lang.String buildGroup)` Deprecated.
`Connector`	`withClassId(java.lang.String classId)`
`Connector`	`withConfig(java.util.Collection<KeyValue> __values)`
`Connector`	`withConfig(Connector.Config __value)`
`Connector`	`withConfig(KeyValue... __values)`
`Connector`	`withConnectorScheduledScan(java.util.Collection<ConnectorScheduledScan> __values)`
`Connector`	`withConnectorScheduledScan(ConnectorScheduledScan... __values)` List of scheduled scans for the connector.
`Connector`	`withConnectorServer(java.lang.String connectorServer)`
`Connector`	`withCustomClassId(java.lang.String customClassId)`
`Connector`	`withDefaultDataModelClass(java.lang.String defaultDataModelClass)`
`Connector`	`withDocumentsType(java.lang.String documentsType)`
`Connector`	`withForcedMeta(java.util.Collection<KeyValue> __values)`
`Connector`	`withForcedMeta(Connector.ForcedMeta __value)`
`Connector`	`withForcedMeta(KeyValue... __values)`
`Connector`	`withGenerated(boolean generated)`
`Connector`	`withGenerated(java.lang.Boolean generated)`
`Connector`	`withLogin(java.lang.String login)`
`Connector`	`withManaged(boolean managed)`
`Connector`	`withManaged(java.lang.Boolean managed)`
`Connector`	`withName(java.lang.String name)`
`Connector`	`withPassword(java.lang.String password)`
`Connector`	`withPostProcessingPipeline(PostProcessingPipeline postProcessingPipeline)`
`Connector`	`withPushAPIServer(java.lang.String pushAPIServer)`
`Connector`	`withPushConfig(PushConfig pushConfig)`
`Connector`	`withSourceCachingConfig(SourceCachingConfig sourceCachingConfig)`
`Connector`	`withSourceFetchConfig(SourceFetchConfig sourceFetchConfig)`
`Connector`	`withSourcePreviewConfig(SourcePreviewConfig sourcePreviewConfig)`
`Connector`	`withSourceThumbnailsConfig(SourceThumbnailsConfig sourceThumbnailsConfig)`
`void`	`writeTo(java.io.OutputStream os)` Write this Connector as an XML fragment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - pushConfig
```
public PushConfig pushConfig
```
  - connectorScheduledScan
```
public java.util.List<ConnectorScheduledScan> connectorScheduledScan
```
  - name
```
public java.lang.String name
```
  - classId
```
public java.lang.String classId
```
  - customClassId
```
public java.lang.String customClassId
```
  - managed
```
public boolean managed
```
  - DEFAULT_MANAGED
```
public static final boolean DEFAULT_MANAGED
```
    See Also:
    
    Constant Field Values
  - connectorServer
```
public java.lang.String connectorServer
```
  - buildGroup
```
@Deprecated
public java.lang.String buildGroup
```
    Deprecated.
  - pushAPIServer
```
public java.lang.String pushAPIServer
```
  - authenticationMode
```
public java.lang.String authenticationMode
```
  - DEFAULT_AUTHENTICATION_MODE
```
public static final java.lang.String DEFAULT_AUTHENTICATION_MODE
```
    See Also:
    
    Constant Field Values
  - login
```
public java.lang.String login
```
  - password
```
public java.lang.String password
```
  - config
```
protected Connector.Config config
```
  - forcedMeta
```
protected Connector.ForcedMeta forcedMeta
```
  - defaultDataModelClass
```
public java.lang.String defaultDataModelClass
```
  - sourceCachingConfig
```
public SourceCachingConfig sourceCachingConfig
```
  - sourceFetchConfig
```
public SourceFetchConfig sourceFetchConfig
```
  - sourcePreviewConfig
```
public SourcePreviewConfig sourcePreviewConfig
```
  - sourceThumbnailsConfig
```
public SourceThumbnailsConfig sourceThumbnailsConfig
```
  - documentsType
```
public java.lang.String documentsType
```
  - postProcessingPipeline
```
public PostProcessingPipeline postProcessingPipeline
```
  - generated
```
public boolean generated
```
  - DEFAULT_GENERATED
```
public static final boolean DEFAULT_GENERATED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Connector
```
public Connector()
```
  - Connector
```
public Connector(Connector o)
```
    Copy constructor
- Method Detail
  - isA
```
public static boolean isA(java.lang.String str,
                          Connector.AuthenticationMode item)
```
  - isOneOf
```
public static boolean isOneOf(java.lang.String str,
                              Connector.AuthenticationMode... items)
```
  - setAuthenticationMode
```
public void setAuthenticationMode(Connector.AuthenticationMode item)
```
    The connector configuration parameters.
    Connector parameters such as the data sources or folders to actually index in the data source are provided as key-values.
    No configuration parameters should be provided for unmanaged connectors.
    The set of meta data to be automatically added to indexed documents. These meta-data items are inserted into each document from this connector when analyzing the document. Connector authentication mode values are: public and basic. If set to basic, the indexing-server will require authentication to push content with this connector name.
  - getAuthenticationModeAsEnum
```
public Connector.AuthenticationMode getAuthenticationModeAsEnum()
```
    The connector configuration parameters.
    Connector parameters such as the data sources or folders to actually index in the data source are provided as key-values.
    No configuration parameters should be provided for unmanaged connectors.
    The set of meta data to be automatically added to indexed documents. These meta-data items are inserted into each document from this connector when analyzing the document. Connector authentication mode values are: public and basic. If set to basic, the indexing-server will require authentication to push content with this connector name.
  - setPushConfig
```
public void setPushConfig(PushConfig pushConfig)
```
    Specifies how documents are sent to the indexing-server.
  - getPushConfig
```
public PushConfig getPushConfig()
```
    Specifies how documents are sent to the indexing-server.
  - withPushConfig
```
public Connector withPushConfig(PushConfig pushConfig)
```
  - getConnectorScheduledScan
```
public java.util.List<ConnectorScheduledScan> getConnectorScheduledScan()
```
    List of scheduled scans for the connector.
  - withConnectorScheduledScan
```
public Connector withConnectorScheduledScan(ConnectorScheduledScan... __values)
```
    List of scheduled scans for the connector.
  - withConnectorScheduledScan
```
public Connector withConnectorScheduledScan(java.util.Collection<ConnectorScheduledScan> __values)
```
  - setName
```
public void setName(java.lang.String name)
```
    The name of the connector.
  - getName
```
public java.lang.String getName()
```
    The name of the connector.
  - withName
```
public Connector withName(java.lang.String name)
```
  - setClassId
```
public void setClassId(java.lang.String classId)
```
    Connector class identifier.
    This identifies the kind of data source this connectors connects to,
    as well as the actual implementation.
    The class identifier can be a reference to an exascript class,
    a Java class or a .NET Class.
    This attribute must be null for unmanaged connectors.
    The value provided should be one of the values returned by
    
    See Also:
    
    listConnectorTypes.
  - getClassId
```
public java.lang.String getClassId()
```
    Connector class identifier.
    This identifies the kind of data source this connectors connects to,
    as well as the actual implementation.
    The class identifier can be a reference to an exascript class,
    a Java class or a .NET Class.
    This attribute must be null for unmanaged connectors.
    The value provided should be one of the values returned by
    
    See Also:
    
    listConnectorTypes.
  - withClassId
```
public Connector withClassId(java.lang.String classId)
```
  - setCustomClassId
```
public void setCustomClassId(java.lang.String customClassId)
```
    Implementation class identifier.
    Optional.
    Can be used to specify a custom implementation of the connector.
  - getCustomClassId
```
public java.lang.String getCustomClassId()
```
    Implementation class identifier.
    Optional.
    Can be used to specify a custom implementation of the connector.
  - withCustomClassId
```
public Connector withCustomClassId(java.lang.String customClassId)
```
  - setManaged
```
public void setManaged(boolean managed)
```
    Indicates that the connector is managed by a framework.
    A managed connector is launched and operated as a CloudView service, whereas an 'unmanaged connector' is handled by a third-party process.
  - isManaged
```
public boolean isManaged()
```
    Indicates that the connector is managed by a framework.
    A managed connector is launched and operated as a CloudView service, whereas an 'unmanaged connector' is handled by a third-party process.
  - withManaged
```
public Connector withManaged(boolean managed)
```
  - withManaged
```
public Connector withManaged(java.lang.Boolean managed)
```
  - setConnectorServer
```
public void setConnectorServer(java.lang.String connectorServer)
```
    Defines the connector server hosting this connector.
    For managed connectors only. Connectors are deployed in a connector server. There are 3 kinds of connector server: exascript, Java or .NET. The value of this attribute should refer to a connector server defined in the deployment configuration (for example, exa0, java0, dotnet0).
  - getConnectorServer
```
public java.lang.String getConnectorServer()
```
    Defines the connector server hosting this connector.
    For managed connectors only. Connectors are deployed in a connector server. There are 3 kinds of connector server: exascript, Java or .NET. The value of this attribute should refer to a connector server defined in the deployment configuration (for example, exa0, java0, dotnet0).
  - withConnectorServer
```
public Connector withConnectorServer(java.lang.String connectorServer)
```
  - setBuildGroup
```
@Deprecated
public void setBuildGroup(java.lang.String buildGroup)
```
    Deprecated.
    
    Defines the build group that will receive the documents.
    For managed connectors only. For a single connector server, different connectors can push to different build groups.
  - getBuildGroup
```
@Deprecated
public java.lang.String getBuildGroup()
```
    Deprecated.
    
    Defines the build group that will receive the documents.
    For managed connectors only. For a single connector server, different connectors can push to different build groups.
  - withBuildGroup
```
@Deprecated
public Connector withBuildGroup(java.lang.String buildGroup)
```
    Deprecated.
  - setPushAPIServer
```
public void setPushAPIServer(java.lang.String pushAPIServer)
```
    Defines the Push API server that will receive the documents.
    For managed connectors only. For a single connector server, different connectors can push to different Push API servers.
  - getPushAPIServer
```
public java.lang.String getPushAPIServer()
```
    Defines the Push API server that will receive the documents.
    For managed connectors only. For a single connector server, different connectors can push to different Push API servers.
  - withPushAPIServer
```
public Connector withPushAPIServer(java.lang.String pushAPIServer)
```
  - setAuthenticationMode
```
public void setAuthenticationMode(java.lang.String authenticationMode)
```
    The connector configuration parameters.
    Connector parameters such as the data sources or folders to actually index in the data source are provided as key-values.
    No configuration parameters should be provided for unmanaged connectors.
    The set of meta data to be automatically added to indexed documents. These meta-data items are inserted into each document from this connector when analyzing the document. Connector authentication mode values are: public and basic. If set to basic, the indexing-server will require authentication to push content with this connector name.
  - getAuthenticationMode
```
public java.lang.String getAuthenticationMode()
```
    The connector configuration parameters.
    Connector parameters such as the data sources or folders to actually index in the data source are provided as key-values.
    No configuration parameters should be provided for unmanaged connectors.
    The set of meta data to be automatically added to indexed documents. These meta-data items are inserted into each document from this connector when analyzing the document. Connector authentication mode values are: public and basic. If set to basic, the indexing-server will require authentication to push content with this connector name.
  - withAuthenticationMode
```
public Connector withAuthenticationMode(java.lang.String authenticationMode)
```
  - setLogin
```
public void setLogin(java.lang.String login)
```
    User login if authenticationMode parameter is set to basic.
  - getLogin
```
public java.lang.String getLogin()
```
    User login if authenticationMode parameter is set to basic.
  - withLogin
```
public Connector withLogin(java.lang.String login)
```
  - setPassword
```
public void setPassword(java.lang.String password)
```
    User password if authenticationMode parameter is set to basic.
  - getPassword
```
public java.lang.String getPassword()
```
    User password if authenticationMode parameter is set to basic.
  - withPassword
```
public Connector withPassword(java.lang.String password)
```
  - getConfig
```
public Connector.Config getConfig()
```
  - setConfig
```
public void setConfig(Connector.Config __value)
```
  - withConfig
```
public Connector withConfig(KeyValue... __values)
```
  - withConfig
```
public Connector withConfig(java.util.Collection<KeyValue> __values)
```
  - withConfig
```
public Connector withConfig(Connector.Config __value)
```
  - getForcedMeta
```
public Connector.ForcedMeta getForcedMeta()
```
  - setForcedMeta
```
public void setForcedMeta(Connector.ForcedMeta __value)
```
  - withForcedMeta
```
public Connector withForcedMeta(KeyValue... __values)
```
  - withForcedMeta
```
public Connector withForcedMeta(java.util.Collection<KeyValue> __values)
```
  - withForcedMeta
```
public Connector withForcedMeta(Connector.ForcedMeta __value)
```
  - setDefaultDataModelClass
```
public void setDefaultDataModelClass(java.lang.String defaultDataModelClass)
```
    Specifies the class in which the documents should be indexed if the connector does not provide a dataModelClass indication for its documents.
    The default value (null) means that the documents will go in the default class of the DataModel.
  - getDefaultDataModelClass
```
public java.lang.String getDefaultDataModelClass()
```
    Specifies the class in which the documents should be indexed if the connector does not provide a dataModelClass indication for its documents.
    The default value (null) means that the documents will go in the default class of the DataModel.
  - withDefaultDataModelClass
```
public Connector withDefaultDataModelClass(java.lang.String defaultDataModelClass)
```
  - setSourceCachingConfig
```
public void setSourceCachingConfig(SourceCachingConfig sourceCachingConfig)
```
  - getSourceCachingConfig
```
public SourceCachingConfig getSourceCachingConfig()
```
  - withSourceCachingConfig
```
public Connector withSourceCachingConfig(SourceCachingConfig sourceCachingConfig)
```
  - setSourceFetchConfig
```
public void setSourceFetchConfig(SourceFetchConfig sourceFetchConfig)
```
  - getSourceFetchConfig
```
public SourceFetchConfig getSourceFetchConfig()
```
  - withSourceFetchConfig
```
public Connector withSourceFetchConfig(SourceFetchConfig sourceFetchConfig)
```
  - setSourcePreviewConfig
```
public void setSourcePreviewConfig(SourcePreviewConfig sourcePreviewConfig)
```
  - getSourcePreviewConfig
```
public SourcePreviewConfig getSourcePreviewConfig()
```
  - withSourcePreviewConfig
```
public Connector withSourcePreviewConfig(SourcePreviewConfig sourcePreviewConfig)
```
  - setSourceThumbnailsConfig
```
public void setSourceThumbnailsConfig(SourceThumbnailsConfig sourceThumbnailsConfig)
```
  - getSourceThumbnailsConfig
```
public SourceThumbnailsConfig getSourceThumbnailsConfig()
```
  - withSourceThumbnailsConfig
```
public Connector withSourceThumbnailsConfig(SourceThumbnailsConfig sourceThumbnailsConfig)
```
  - setDocumentsType
```
public void setDocumentsType(java.lang.String documentsType)
```
    Type of documents produced by this source.
    The type of documents must match one of the types declared in your CloudView license file.
  - getDocumentsType
```
public java.lang.String getDocumentsType()
```
    Type of documents produced by this source.
    The type of documents must match one of the types declared in your CloudView license file.
  - withDocumentsType
```
public Connector withDocumentsType(java.lang.String documentsType)
```
  - setPostProcessingPipeline
```
public void setPostProcessingPipeline(PostProcessingPipeline postProcessingPipeline)
```
    Pipeline post-processing documents sent by this connector.
  - getPostProcessingPipeline
```
public PostProcessingPipeline getPostProcessingPipeline()
```
    Pipeline post-processing documents sent by this connector.
  - withPostProcessingPipeline
```
public Connector withPostProcessingPipeline(PostProcessingPipeline postProcessingPipeline)
```
  - setGenerated
```
public void setGenerated(boolean generated)
```
    Has this connector been generated automatically by another component or it has been manually added by the user.
    A generated connector must be configured by the component that has generated it and won't be editable in admin-ui
  - isGenerated
```
public boolean isGenerated()
```
    Has this connector been generated automatically by another component or it has been manually added by the user.
    A generated connector must be configured by the component that has generated it and won't be editable in admin-ui
  - withGenerated
```
public Connector withGenerated(boolean generated)
```
  - withGenerated
```
public Connector withGenerated(java.lang.Boolean generated)
```
  - makeCopy
```
public Connector makeCopy()
```
    Creates and returns a deep copy of this Connector.
  - readFrom
```
public static Connector readFrom(java.io.InputStream is)
                          throws javax.xml.bind.JAXBException
```
    Read this Connector 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 Connector as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static Connector fromString(java.lang.String s)
                            throws javax.xml.bind.JAXBException,
                                   java.io.UnsupportedEncodingException
```
    String representation of this Connector.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this Connector.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this Connector.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class Connector

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pushConfig

connectorScheduledScan

name

classId

customClassId

managed

DEFAULT_MANAGED

connectorServer

buildGroup

pushAPIServer

authenticationMode

DEFAULT_AUTHENTICATION_MODE

login

password

config

forcedMeta

defaultDataModelClass

sourceCachingConfig

sourceFetchConfig

sourcePreviewConfig

sourceThumbnailsConfig

documentsType

postProcessingPipeline

generated

DEFAULT_GENERATED

Constructor Detail

Connector

Connector

Method Detail

isA

isOneOf

setAuthenticationMode

getAuthenticationModeAsEnum

setPushConfig

getPushConfig

withPushConfig

getConnectorScheduledScan

withConnectorScheduledScan

withConnectorScheduledScan

setName

getName

withName

setClassId

getClassId

withClassId

setCustomClassId

getCustomClassId

withCustomClassId

setManaged

isManaged

withManaged

withManaged

setConnectorServer

getConnectorServer

withConnectorServer

setBuildGroup

getBuildGroup

withBuildGroup

setPushAPIServer

getPushAPIServer

withPushAPIServer

setAuthenticationMode

getAuthenticationMode

withAuthenticationMode

setLogin

getLogin

withLogin

setPassword

getPassword

withPassword

getConfig

setConfig

withConfig