com.waveset.adapter
Interface ActiveSync

All Known Subinterfaces:
ConfirmedSync
All Known Implementing Classes:
ADSIResourceAdapter, DatabaseTableResourceAdapter, DominoResourceAdapter, FlatFileActiveSyncAdapter, JmsListenerResourceAdapter, LDAPActiveSyncAdapterBase, LDAPResourceAdapterBase, MIISResourceAdapter, NDSResourceAdapter, PeopleSoftComponentActiveSyncAdapter, PeopleSoftResourceAdapter, RemedyResourceAdapter, SAPHRActiveSyncAdapter, ScriptedJdbcResourceAdapter, SiebelCRMResourceAdapter, SiebelResourceAdapter, SkeletonActiveSyncAdapter, SkeletonActiveSyncResourceAdapter, SkeletonStandardAndActiveSyncResourceAdapter, SmartRolesResourceAdapter, TopSecretResourceAdapter

public interface ActiveSync

Implement this interface to be an event source.

See Also:
IAPI

Field Summary
static java.lang.String ACTIVE_SYNC_EVENT_RES_ATTRS_XML
           
static java.lang.String ACTIVE_SYNC_STD_RES_ATTRS_XML
           
static java.lang.String ATTR_IS_DELETED
           
static java.lang.String code_id
          This is only public so that it can be contained in an interface.
static java.lang.String DATE_FORMAT
           
static java.lang.String DATE_TIME_FORMAT
           
static java.lang.String RA_APPLY_META_VIEW
           
static java.lang.String RA_ASSIGN_SOURCE_ON_CREATE
           
static java.lang.String RA_CONFIRMATION_RULE
           
static java.lang.String RA_CORRELATION_RULE
           
static java.lang.String RA_CREATE_UNMATCHED
           
static java.lang.String RA_DELETE_RULE
           
static java.lang.String RA_FORM
           
static java.lang.String RA_ID
           
static java.lang.String RA_IDM_NAME_RULE
           
static java.lang.String RA_LEGACY_EVENT_GEN
           
static java.lang.String RA_LOG_LEVEL
           
static java.lang.String RA_LOG_PATH
           
static java.lang.String RA_LOG_SIZE
           
static java.lang.String RA_MAX_AGE_LENGTH
           
static java.lang.String RA_MAX_AGE_UNIT
           
static java.lang.String RA_MAX_ARCHIVES
           
static java.lang.String RA_NAME
          Known resource attribute names for configuration.
static java.lang.String RA_PARAMETERIZED_INPUT_FORM
           
static java.lang.String RA_POPULATE_GLOBAL
           
static java.lang.String RA_POSTPOLL_WORKFLOW
           
static java.lang.String RA_PREPOLL_WORKFLOW
           
static java.lang.String RA_PROCESS_RULE
           
static java.lang.String RA_PROXY_ADMINISTRATOR
           
static java.lang.String RA_RESET_TO_TODAY
           
static java.lang.String RA_RESOLVE_PROCESS_RULE
           
static java.lang.String RA_SCHEDULE_INTERVAL
           
static java.lang.String RA_SCHEDULE_INTERVAL_COUNT
           
static java.lang.String RA_SCHEDULE_START_DATE
           
static java.lang.String RA_SCHEDULE_START_TIME
           
static java.lang.String RA_SYNC_CONFIG_MODE
           
static java.lang.String RA_SYNC_POST_PROCESS_FORM
           
static java.lang.String RA_UPDATE_IF_DELETE
          Deprecated. As of IdM 5.5
static java.lang.String RA_USE_INPUT_FORM
           
static java.lang.String TIME_FORMAT
           
static int TRACE_LEVEL_DEBUG
           
static int TRACE_LEVEL_ERROR
           
static int TRACE_LEVEL_INFO
           
static int TRACE_LEVEL_NONE
           
static int TRACE_LEVEL_WARNING
           
 
Method Summary
 java.lang.Object getAttributeValue(java.lang.String name)
          Get or set an attribute value for the ActiveSync.
 void init()
          initialize yourself.
 int poll()
          The poll method.
 void setAttributeValue(java.lang.String name, java.lang.Object value)
           
 void shutdown()
          shutdown
 

Field Detail

code_id

public static final java.lang.String code_id
This is only public so that it can be contained in an interface.

See Also:
Constant Field Values

RA_NAME

public static final java.lang.String RA_NAME
Known resource attribute names for configuration. I don't like this, it should be a bag of attributes.

See Also:
Constant Field Values

RA_ID

public static final java.lang.String RA_ID
See Also:
Constant Field Values

RA_PROXY_ADMINISTRATOR

public static final java.lang.String RA_PROXY_ADMINISTRATOR
See Also:
Constant Field Values

RA_FORM

public static final java.lang.String RA_FORM
See Also:
Constant Field Values

RA_LOG_PATH

public static final java.lang.String RA_LOG_PATH
See Also:
Constant Field Values

RA_LOG_SIZE

public static final java.lang.String RA_LOG_SIZE
See Also:
Constant Field Values

RA_LOG_LEVEL

public static final java.lang.String RA_LOG_LEVEL
See Also:
Constant Field Values

RA_MAX_ARCHIVES

public static final java.lang.String RA_MAX_ARCHIVES
See Also:
Constant Field Values

RA_MAX_AGE_UNIT

public static final java.lang.String RA_MAX_AGE_UNIT
See Also:
Constant Field Values

RA_MAX_AGE_LENGTH

public static final java.lang.String RA_MAX_AGE_LENGTH
See Also:
Constant Field Values

RA_SCHEDULE_INTERVAL

public static final java.lang.String RA_SCHEDULE_INTERVAL
See Also:
Constant Field Values

RA_SCHEDULE_INTERVAL_COUNT

public static final java.lang.String RA_SCHEDULE_INTERVAL_COUNT
See Also:
Constant Field Values

RA_SCHEDULE_START_TIME

public static final java.lang.String RA_SCHEDULE_START_TIME
See Also:
Constant Field Values

RA_SCHEDULE_START_DATE

public static final java.lang.String RA_SCHEDULE_START_DATE
See Also:
Constant Field Values

RA_RESET_TO_TODAY

public static final java.lang.String RA_RESET_TO_TODAY
See Also:
Constant Field Values

RA_UPDATE_IF_DELETE

public static final java.lang.String RA_UPDATE_IF_DELETE
Deprecated. As of IdM 5.5

See Also:
Constant Field Values

RA_PREPOLL_WORKFLOW

public static final java.lang.String RA_PREPOLL_WORKFLOW
See Also:
Constant Field Values

RA_POSTPOLL_WORKFLOW

public static final java.lang.String RA_POSTPOLL_WORKFLOW
See Also:
Constant Field Values

RA_PROCESS_RULE

public static final java.lang.String RA_PROCESS_RULE
See Also:
Constant Field Values

RA_CORRELATION_RULE

public static final java.lang.String RA_CORRELATION_RULE
See Also:
Constant Field Values

RA_CONFIRMATION_RULE

public static final java.lang.String RA_CONFIRMATION_RULE
See Also:
Constant Field Values

RA_DELETE_RULE

public static final java.lang.String RA_DELETE_RULE
See Also:
Constant Field Values

RA_RESOLVE_PROCESS_RULE

public static final java.lang.String RA_RESOLVE_PROCESS_RULE
See Also:
Constant Field Values

RA_CREATE_UNMATCHED

public static final java.lang.String RA_CREATE_UNMATCHED
See Also:
Constant Field Values

RA_POPULATE_GLOBAL

public static final java.lang.String RA_POPULATE_GLOBAL
See Also:
Constant Field Values

RA_ASSIGN_SOURCE_ON_CREATE

public static final java.lang.String RA_ASSIGN_SOURCE_ON_CREATE
See Also:
Constant Field Values

RA_IDM_NAME_RULE

public static final java.lang.String RA_IDM_NAME_RULE
See Also:
Constant Field Values

RA_USE_INPUT_FORM

public static final java.lang.String RA_USE_INPUT_FORM
See Also:
Constant Field Values

RA_PARAMETERIZED_INPUT_FORM

public static final java.lang.String RA_PARAMETERIZED_INPUT_FORM
See Also:
Constant Field Values

RA_SYNC_POST_PROCESS_FORM

public static final java.lang.String RA_SYNC_POST_PROCESS_FORM
See Also:
Constant Field Values

RA_SYNC_CONFIG_MODE

public static final java.lang.String RA_SYNC_CONFIG_MODE
See Also:
Constant Field Values

RA_APPLY_META_VIEW

public static final java.lang.String RA_APPLY_META_VIEW
See Also:
Constant Field Values

RA_LEGACY_EVENT_GEN

public static final java.lang.String RA_LEGACY_EVENT_GEN
See Also:
Constant Field Values

DATE_FORMAT

public static final java.lang.String DATE_FORMAT
See Also:
Constant Field Values

TIME_FORMAT

public static final java.lang.String TIME_FORMAT
See Also:
Constant Field Values

DATE_TIME_FORMAT

public static final java.lang.String DATE_TIME_FORMAT
See Also:
Constant Field Values

ATTR_IS_DELETED

public static final java.lang.String ATTR_IS_DELETED
See Also:
Constant Field Values

TRACE_LEVEL_NONE

public static final int TRACE_LEVEL_NONE
See Also:
Constant Field Values

TRACE_LEVEL_ERROR

public static final int TRACE_LEVEL_ERROR
See Also:
Constant Field Values

TRACE_LEVEL_INFO

public static final int TRACE_LEVEL_INFO
See Also:
Constant Field Values

TRACE_LEVEL_WARNING

public static final int TRACE_LEVEL_WARNING
See Also:
Constant Field Values

TRACE_LEVEL_DEBUG

public static final int TRACE_LEVEL_DEBUG
See Also:
Constant Field Values

ACTIVE_SYNC_STD_RES_ATTRS_XML

public static final java.lang.String ACTIVE_SYNC_STD_RES_ATTRS_XML
See Also:
Constant Field Values

ACTIVE_SYNC_EVENT_RES_ATTRS_XML

public static final java.lang.String ACTIVE_SYNC_EVENT_RES_ATTRS_XML
See Also:
Constant Field Values
Method Detail

init

public void init()
          throws java.lang.Exception
initialize yourself. throw exception if initialization failed

Throws:
java.lang.Exception

shutdown

public void shutdown()
shutdown


getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String name)
                                   throws java.lang.Exception
Get or set an attribute value for the ActiveSync. Setting an attribute value only changes the in-memory copy of the attribute, not the persistent value. Set is typically only used for status or scheduling updates.

Throws:
java.lang.Exception

setAttributeValue

public void setAttributeValue(java.lang.String name,
                              java.lang.Object value)
                       throws java.lang.Exception
Throws:
java.lang.Exception

poll

public int poll()
         throws java.lang.InterruptedException
The poll method. Called at a configurable interval, this
  1. polls the remote resource for changes,
  2. converts them to IAPI calls, and
  3. posts them back to the server.

Returns:
0 if no work done, n if n calls processed.
Throws:
java.lang.InterruptedException