blackboard.platform.dataintegration
Class DataIntegration

java.lang.Object
  extended by blackboard.data.AbstractIdentifiable
      extended by blackboard.platform.dataintegration.DataIntegration
All Implemented Interfaces:
blackboard.data.HasExtendedData, Identifiable

public class DataIntegration
extends blackboard.data.AbstractIdentifiable
implements blackboard.data.HasExtendedData

Class that represents a configured data integration.

Since:
Bb 9.1 SP6

Nested Class Summary
static class DataIntegration.IntegrationState
          The state of the DataIntegration.
 
Field Summary
static DataType DATA_TYPE
           
 
Constructor Summary
DataIntegration()
           
 
Method Summary
 java.lang.String getAuthPassword()
          Get the data integration's password.
 java.lang.String getBatchUidPrefix()
          Get the string with which all batch UIDs created by this integration should be prefixed.
 java.lang.String getDataSourceBatchUid()
          Get the batch UID of the data source that the data created by this data integration will be associated with.
 java.lang.String getDescription()
           
 blackboard.data.ExtendedData getExtendedData()
          Get the extended data attribute in which additional settings can be stored.
 java.lang.String getGuid()
          Get the GUID of the DataIntegration.
 DataIntegration.IntegrationState getIntegrationState()
           
 LogLevel getLogLevel()
          Get the level at which logging will occur for this data integration.
 java.lang.String getName()
          Get the name of the data integration.
 java.lang.String getTypeHandle()
          Get the type of data integration.
 void setAuthPassword(java.lang.String authPassword)
          Set the data integration's password.
 void setBatchUidPrefix(java.lang.String batchUidPrefix)
          Set the string with which all batch UIDs created by this integration should be prefixed.
 void setDataSourceBatchUid(java.lang.String dataSourceBatchUid)
          Set the batch UID of the data source that the data created by this data integration will be associated with.
 void setDescription(java.lang.String description)
           
 void setExtendedData(blackboard.data.ExtendedData ed)
          Set the extended data attribute in which additional settings can be stored.
 void setGuid(java.lang.String guid)
          Set the GUID of the DataIntegration.
 void setIntegrationState(DataIntegration.IntegrationState integrationState)
          Set the state of the integration.
 void setLogLevel(LogLevel logLevel)
          Set the level at which logging will occur for this data integration.
 void setName(java.lang.String name)
          Set the name of the data integration.
 void setTypeHandle(java.lang.String typeHandle)
          Set the type of the data integration.
 
Methods inherited from class blackboard.data.AbstractIdentifiable
equals, getDataType, getId, getMaxLength, hashCode, setId, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DATA_TYPE

public static final DataType DATA_TYPE
Constructor Detail

DataIntegration

public DataIntegration()
Method Detail

getGuid

public java.lang.String getGuid()
Get the GUID of the DataIntegration. Used as the user name when using the DataIntegrationAuthenticator.authenticate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) method.

Returns:
The GUID.

setGuid

public void setGuid(java.lang.String guid)
Set the GUID of the DataIntegration. For new DataIntegrations, this will be pre-set to a random id.

Parameters:
guid - The GUID to set.

getName

public java.lang.String getName()
Get the name of the data integration.

Returns:
The name of the data integration.

setName

public void setName(java.lang.String name)
Set the name of the data integration.

Parameters:
name - The name of the data integration.

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getTypeHandle

public java.lang.String getTypeHandle()
Get the type of data integration. This is the value from the <data-integration-handler> in the bb-manifest.xml Building Block manifest.

Returns:
The data integration's type.

setTypeHandle

public void setTypeHandle(java.lang.String typeHandle)
Set the type of the data integration.

Parameters:
typeHandle - The type of the data integration.

getIntegrationState

public DataIntegration.IntegrationState getIntegrationState()

setIntegrationState

public void setIntegrationState(DataIntegration.IntegrationState integrationState)
Set the state of the integration.

Parameters:
integrationState - The state of the integration

getAuthPassword

public java.lang.String getAuthPassword()
Get the data integration's password. This is the password checked when using the DataIntegrationAuthenticator.authenticate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) method.

Returns:
The data integration's password.

setAuthPassword

public void setAuthPassword(java.lang.String authPassword)
Set the data integration's password.

Parameters:
authPassword - The data integration's password.

getDataSourceBatchUid

public java.lang.String getDataSourceBatchUid()
Get the batch UID of the data source that the data created by this data integration will be associated with.

Returns:
The data source batch uid.

setDataSourceBatchUid

public void setDataSourceBatchUid(java.lang.String dataSourceBatchUid)
Set the batch UID of the data source that the data created by this data integration will be associated with.

Parameters:
dataSourceBatchUid - The data source batch uid.

getBatchUidPrefix

public java.lang.String getBatchUidPrefix()
Get the string with which all batch UIDs created by this integration should be prefixed.

This is used by DataIntegrationUtil.constructBatchUid(String, DataIntegration).

Returns:
The batch UID prefix.

setBatchUidPrefix

public void setBatchUidPrefix(java.lang.String batchUidPrefix)
Set the string with which all batch UIDs created by this integration should be prefixed.

Parameters:
batchUidPrefix - The batch UID prefix.

getExtendedData

public blackboard.data.ExtendedData getExtendedData()
Get the extended data attribute in which additional settings can be stored.

Specified by:
getExtendedData in interface blackboard.data.HasExtendedData
Returns:
The extended data attribute.

setExtendedData

public void setExtendedData(blackboard.data.ExtendedData ed)
Set the extended data attribute in which additional settings can be stored.

Specified by:
setExtendedData in interface blackboard.data.HasExtendedData
Parameters:
ed - The extended data attribute.

setLogLevel

public void setLogLevel(LogLevel logLevel)
Set the level at which logging will occur for this data integration.

Parameters:
logLevel - The log level.

getLogLevel

public LogLevel getLogLevel()
Get the level at which logging will occur for this data integration.

Returns:
The log level.


Copyright 2011 Blackboard, Inc. All Rights Reserved.