com.waveset.object
Class IAPI

java.lang.Object
  extended bycom.waveset.util.AbstractXmlObject
      extended bycom.waveset.object.IAPI
All Implemented Interfaces:
javax.naming.Referenceable, XmlObject
Direct Known Subclasses:
IAPIProcess, IAPIUser

Deprecated. - Adapters should use com.waveset.adapter.iapi.IAPI.

This class is preserved solely for backward-compatibility. It will not work unless the IDM server classes are available.

public abstract class IAPI
extends AbstractXmlObject


Nested Class Summary
static class IAPI.IAPIException
          Deprecated.  
static class IAPI.InternalErrorException
          Deprecated.  
static class IAPI.MissingRequiredAttributeException
          Deprecated.  
static class IAPI.UnimplementedException
          Deprecated.  
static class IAPI.UnknownAttributeException
          Deprecated.  
 
Field Summary
protected static java.lang.Class _clIAPI
          Deprecated. A handle to the new IAPI interface in the 'iapi' package.
protected static java.lang.Class _clIAPIFactory
          Deprecated. A handle to the new IAPI factory in the 'iapi' package.
protected  java.lang.Object _objIAPI
          Deprecated. Handle to a "real" IAPI object (com.waveset.adapter.iapi.IAPI) held as a handle to java.lang.Object in order to avoid compile-time and load-time static dependencies.
static java.lang.String ATT_CANCEL_OPTION
          Deprecated.  
static java.lang.String ATT_CHECKIN_OPTIONS
          Deprecated. Constants for things to put in the view
static java.lang.String ATTRIBUTE_FUTURE_DATA
          Deprecated. This is a attribute of type Map with the keys being String of DATE_FORMAT.
static java.lang.String ATTRIBUTE_FUTURE_DATA_ATTRIBUTES
          Deprecated.  
static java.lang.String ATTRIBUTE_FUTURE_DATA_EFFECTIVE_DATE
          Deprecated.  
static java.lang.String ATTRIBUTE_FUTURE_DATA_WORKFLOW
          Deprecated.  
static java.lang.String code_id
          Deprecated.  
static java.lang.String COMMAND_CREATE
          Deprecated. Commands supported by the generic events
static java.lang.String COMMAND_DELETE
          Deprecated.  
static java.lang.String COMMAND_GET
          Deprecated.  
static java.lang.String COMMAND_LIST
          Deprecated.  
static java.lang.String COMMAND_UPDATE
          Deprecated.  
static java.lang.String ELEMENT
          Deprecated. Our XML element name.
static java.lang.String OPTION_CREATE_IF_MISSING
          Deprecated. Options supported by generic events
static java.lang.String OPTION_DELETE_EVENT_DETECTED
          Deprecated.  
static java.lang.String OPTION_FUTURE_DATA_WORKFLOW
          Deprecated. Name of the workflow to run when future data effective date arrives.
static java.lang.String OPTION_REMOTE_ADMIN_NAME
          Deprecated.  
protected static java.lang.String RA_FORM
          Deprecated. Name of a required source attribute: ActiveSync#RA_FORM.
protected static java.lang.String RA_LOG_LEVEL
          Deprecated. Name of a optional source attribute: ActiveSync#RA_LOG_SIZE.
protected static java.lang.String RA_LOG_PATH
          Deprecated. Name of a optional source attribute: ActiveSync#RA_LOG_PATH.
protected static java.lang.String RA_LOG_SIZE
          Deprecated. Name of a optional source attribute: ActiveSync#RA_LOG_SIZE.
protected static java.lang.String RA_NAME
          Deprecated. Name of a required source attribute: ActiveSync#RA_NAME.
protected static java.lang.String RA_PROXY_ADMINISTRATOR
          Deprecated. Name of a required source attribute: ActiveSync#RA_PROXY_ADMINISTRATOR.
protected static Trace trace
          Deprecated.  
static int TRACE_LEVEL_DEBUG
          Deprecated.  
static int TRACE_LEVEL_ERROR
          Deprecated.  
static int TRACE_LEVEL_INFO
          Deprecated.  
static int TRACE_LEVEL_NONE
          Deprecated.  
static int TRACE_LEVEL_WARNING
          Deprecated.  
 
Fields inherited from class com.waveset.util.AbstractXmlObject
_trace
 
Constructor Summary
IAPI()
          Deprecated.  
IAPI(org.w3c.dom.Element e)
          Deprecated. Build an object by parsing its DOM representation.
IAPI(java.util.Map options, java.util.Map attributes, java.lang.String command, java.lang.String type, java.util.Map sourceAttributes)
          Deprecated. This is the standard constructor.
IAPI(java.util.Map options, java.util.Map attributes, java.lang.String command, java.lang.String type, Resource source)
          Deprecated. This is the standard constructer.
 
Method Summary
static void addXmlHeader(java.lang.StringBuffer b, java.lang.String element)
          Deprecated. Adds a standard XML header, DOCTYPE statement and element start tag.
abstract  WavesetResult cancel()
          Deprecated.  
 WavesetResult delete()
          Deprecated.  
abstract  java.util.List find(java.util.List attrNames, java.util.List values, java.util.List conditions, int maxToFind)
          Deprecated.  
abstract  java.util.List find(java.lang.String attrName, java.lang.String value, int maxToFind, boolean contains)
          Deprecated. Find the first maxToFind entries that match the parameters.
static java.lang.String getApplicationName(java.lang.String raName)
          Deprecated.  
 java.lang.String getAttributeNamespace()
          Deprecated.  
 java.util.Map getAttributes()
          Deprecated.  
 java.lang.String getCommand()
          Deprecated.  
 java.lang.String getElementName()
          Deprecated. Return the element name.
 boolean getNoGlobalAattributes()
          Deprecated.  
 java.util.Set getOptionalAttributeNames()
          Deprecated.  
 java.util.Map getOptions()
          Deprecated.  
 java.lang.Object getProperty(java.lang.String name)
          Deprecated.  
 java.util.Set getRequiredAttributeNames()
          Deprecated.  
abstract  WavesetResult getResult()
          Deprecated.  
 int getRetryCount()
          Deprecated. count to retry if temporary exception is hit (like object in user) Assuming a retryInterval of ten seconds, and we want to retry for 30 minutes, we need (60/10)*30 = 180 retries
 int getRetryInterval()
          Deprecated. interval in miliseconds
protected static java.lang.String getStringConstant(java.lang.String constantName, java.lang.String dflt)
          Deprecated.  
 Subject getSubject()
          Deprecated.  
 java.lang.String getTraceFile()
          Deprecated. Use #setLogger(IActiveSyncLogger) instead
 int getTraceLevel()
          Deprecated.  
 java.lang.String getType()
          Deprecated.  
 java.lang.String getViewID()
          Deprecated.  
 void removeProperty(java.lang.String name)
          Deprecated.  
 void setAttributeNamespace(java.lang.String name)
          Deprecated. incoming attributes from the active sync adapter will be put in this named object in the view.
 void setAttributes(java.util.Map attributes)
          Deprecated.  
 void setCommand(java.lang.String command)
          Deprecated.  
 void setLogger(java.lang.Object logger)
          Deprecated.  
 void setNoGlobalAattributes(boolean val)
          Deprecated.  
 void setOptions(java.util.Map options)
          Deprecated.  
 void setProperty(java.lang.String name, java.lang.Object value)
          Deprecated.  
 void setTraceFile(java.lang.String fullFilePath)
          Deprecated. Use #setLogger(IActiveSyncLogger) instead
 void setTraceLevel(int level)
          Deprecated. Use #setLogger(IActiveSyncLogger) instead
 void setType(java.lang.String type)
          Deprecated.  
 void setViewID(java.lang.String ID)
          Deprecated.  
abstract  WavesetResult submit()
          Deprecated.  
protected static void throwIAPIException(java.lang.Throwable th)
          Deprecated. Map any throwable from the "real" IAPI back to a com.waveset.object.IAPI$IAPIException (or to a RuntimeException).
protected static void throwWavesetException(java.lang.Throwable th)
          Deprecated. Map any throwable from the "real" IAPI back to a com.waveset.util.WavesetException (or to a RuntimeException).
 java.lang.String toString()
          Deprecated.  
 java.lang.String toXml()
          Deprecated. Serialize the object to an XML string.
 void toXml(java.lang.StringBuffer b)
          Deprecated. Serialize the object as XML into a string buffer.
 void toXml(java.lang.StringBuffer b, int indent)
          Deprecated. Serialize the object as XML with an optional indentation.
 boolean traceLevelSet(int level)
          Deprecated.  
 void traceString(int level, java.lang.String data)
          Deprecated.  
 void traceString(int level, java.lang.String data, boolean addTimeStamp)
          Deprecated.  
 
Methods inherited from class com.waveset.util.AbstractXmlObject
cloneObject, dump, dumpFile, getReference, println, setTrace, toIdentityString, toVerboseString, toVerboseString, toXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

code_id

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

trace

protected static final Trace trace
Deprecated. 

_clIAPI

protected static java.lang.Class _clIAPI
Deprecated. 
A handle to the new IAPI interface in the 'iapi' package.


_clIAPIFactory

protected static java.lang.Class _clIAPIFactory
Deprecated. 
A handle to the new IAPI factory in the 'iapi' package.


ELEMENT

public static final java.lang.String ELEMENT
Deprecated. 
Our XML element name.


COMMAND_CREATE

public static final java.lang.String COMMAND_CREATE
Deprecated. 
Commands supported by the generic events


COMMAND_UPDATE

public static final java.lang.String COMMAND_UPDATE
Deprecated. 

COMMAND_GET

public static final java.lang.String COMMAND_GET
Deprecated. 

COMMAND_DELETE

public static final java.lang.String COMMAND_DELETE
Deprecated. 

COMMAND_LIST

public static final java.lang.String COMMAND_LIST
Deprecated. 

OPTION_CREATE_IF_MISSING

public static final java.lang.String OPTION_CREATE_IF_MISSING
Deprecated. 
Options supported by generic events


OPTION_REMOTE_ADMIN_NAME

public static final java.lang.String OPTION_REMOTE_ADMIN_NAME
Deprecated. 

OPTION_DELETE_EVENT_DETECTED

public static final java.lang.String OPTION_DELETE_EVENT_DETECTED
Deprecated. 

OPTION_FUTURE_DATA_WORKFLOW

public static final java.lang.String OPTION_FUTURE_DATA_WORKFLOW
Deprecated. 
Name of the workflow to run when future data effective date arrives.


ATTRIBUTE_FUTURE_DATA

public static final java.lang.String ATTRIBUTE_FUTURE_DATA
Deprecated. 
This is a attribute of type Map with the keys being String of DATE_FORMAT. Data stored here will not be processed when the event is submitted, it will be processed when the effective date arrives by the future data workflow. Required attibutes are listed immediately after


ATTRIBUTE_FUTURE_DATA_EFFECTIVE_DATE

public static final java.lang.String ATTRIBUTE_FUTURE_DATA_EFFECTIVE_DATE
Deprecated. 

ATTRIBUTE_FUTURE_DATA_WORKFLOW

public static final java.lang.String ATTRIBUTE_FUTURE_DATA_WORKFLOW
Deprecated. 

ATTRIBUTE_FUTURE_DATA_ATTRIBUTES

public static final java.lang.String ATTRIBUTE_FUTURE_DATA_ATTRIBUTES
Deprecated. 

TRACE_LEVEL_NONE

public static final int TRACE_LEVEL_NONE
Deprecated. 

TRACE_LEVEL_ERROR

public static final int TRACE_LEVEL_ERROR
Deprecated. 

TRACE_LEVEL_INFO

public static final int TRACE_LEVEL_INFO
Deprecated. 

TRACE_LEVEL_WARNING

public static final int TRACE_LEVEL_WARNING
Deprecated. 

TRACE_LEVEL_DEBUG

public static final int TRACE_LEVEL_DEBUG
Deprecated. 

ATT_CHECKIN_OPTIONS

public static final java.lang.String ATT_CHECKIN_OPTIONS
Deprecated. 
Constants for things to put in the view


ATT_CANCEL_OPTION

public static final java.lang.String ATT_CANCEL_OPTION
Deprecated. 

RA_PROXY_ADMINISTRATOR

protected static final java.lang.String RA_PROXY_ADMINISTRATOR
Deprecated. 
Name of a required source attribute: ActiveSync#RA_PROXY_ADMINISTRATOR.


RA_NAME

protected static final java.lang.String RA_NAME
Deprecated. 
Name of a required source attribute: ActiveSync#RA_NAME.


RA_FORM

protected static final java.lang.String RA_FORM
Deprecated. 
Name of a required source attribute: ActiveSync#RA_FORM.


RA_LOG_PATH

protected static final java.lang.String RA_LOG_PATH
Deprecated. 
Name of a optional source attribute: ActiveSync#RA_LOG_PATH.


RA_LOG_SIZE

protected static final java.lang.String RA_LOG_SIZE
Deprecated. 
Name of a optional source attribute: ActiveSync#RA_LOG_SIZE.


RA_LOG_LEVEL

protected static final java.lang.String RA_LOG_LEVEL
Deprecated. 
Name of a optional source attribute: ActiveSync#RA_LOG_SIZE.


_objIAPI

protected java.lang.Object _objIAPI
Deprecated. 
Handle to a "real" IAPI object (com.waveset.adapter.iapi.IAPI) held as a handle to java.lang.Object in order to avoid compile-time and load-time static dependencies.

Constructor Detail

IAPI

public IAPI()
Deprecated. 

IAPI

public IAPI(java.util.Map options,
            java.util.Map attributes,
            java.lang.String command,
            java.lang.String type,
            java.util.Map sourceAttributes)
     throws IAPI.IAPIException
Deprecated. 
This is the standard constructor.

Parameters:
options - are specified as constants starting with OPTION_
attributes - are the attributes to be passed into the form for processing (like name, password, etc.) These are form specific and will appear in the global namespace
command - are from the constants starting with COMMAND_
type - is generally specified by the subclass (user, organization, etc)
sourceAttributes - is a map that has the attributes required for a source adapter (specified by the ActiveSync.RA_* constants).

IAPI

public IAPI(java.util.Map options,
            java.util.Map attributes,
            java.lang.String command,
            java.lang.String type,
            Resource source)
     throws IAPI.IAPIException
Deprecated. 
This is the standard constructer.

Parameters:
options - are specified as constants starting with OPTION_
attributes - are the attributes to be passed into the form for processing (like name, password, etc.) Constants for these are where???
command - are from the constants starting with COMMAND_
type - is generally specified by the subclass (user, organization, etc)
source - is the resource that has the attributes required for a source adapter (specified by the ActiveSync.RA_* constants).

IAPI

public IAPI(org.w3c.dom.Element e)
     throws WavesetException
Deprecated. 
Build an object by parsing its DOM representation.

Method Detail

getStringConstant

protected static java.lang.String getStringConstant(java.lang.String constantName,
                                                    java.lang.String dflt)
Deprecated. 

toString

public java.lang.String toString()
Deprecated. 

getApplicationName

public static java.lang.String getApplicationName(java.lang.String raName)
Deprecated. 

setViewID

public void setViewID(java.lang.String ID)
Deprecated. 

getViewID

public java.lang.String getViewID()
Deprecated. 

setOptions

public void setOptions(java.util.Map options)
Deprecated. 

getOptions

public java.util.Map getOptions()
Deprecated. 

setAttributes

public void setAttributes(java.util.Map attributes)
Deprecated. 

getAttributes

public java.util.Map getAttributes()
Deprecated. 

setCommand

public void setCommand(java.lang.String command)
Deprecated. 

getCommand

public java.lang.String getCommand()
Deprecated. 

setType

public void setType(java.lang.String type)
Deprecated. 

getType

public java.lang.String getType()
Deprecated. 

setTraceLevel

public void setTraceLevel(int level)
Deprecated. Use #setLogger(IActiveSyncLogger) instead

Parameters:
level - ignored

getTraceLevel

public int getTraceLevel()
Deprecated. 

setTraceFile

public void setTraceFile(java.lang.String fullFilePath)
Deprecated. Use #setLogger(IActiveSyncLogger) instead

Parameters:
fullFilePath - stored and ignored

getTraceFile

public java.lang.String getTraceFile()
Deprecated. Use #setLogger(IActiveSyncLogger) instead

Returns:
the unused value set by setTraceFile

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
Deprecated. 

removeProperty

public void removeProperty(java.lang.String name)
Deprecated. 

getProperty

public java.lang.Object getProperty(java.lang.String name)
Deprecated. 

getRetryCount

public int getRetryCount()
Deprecated. 
count to retry if temporary exception is hit (like object in user) Assuming a retryInterval of ten seconds, and we want to retry for 30 minutes, we need (60/10)*30 = 180 retries


getRetryInterval

public int getRetryInterval()
Deprecated. 
interval in miliseconds


traceLevelSet

public boolean traceLevelSet(int level)
Deprecated. 
Parameters:
level - - if the trace level is >= level, return true

traceString

public void traceString(int level,
                        java.lang.String data,
                        boolean addTimeStamp)
Deprecated. 
Parameters:
level - - if the trace level is >= level, output the trace string
data - - string to output
addTimeStamp - - add a timestamp at the start of the buffer

traceString

public void traceString(int level,
                        java.lang.String data)
Deprecated. 
Parameters:
level - - if the trace level is >= level, output the trace string
data - - string to output

submit

public abstract WavesetResult submit()
Deprecated. 

getResult

public abstract WavesetResult getResult()
Deprecated. 

cancel

public abstract WavesetResult cancel()
Deprecated. 

delete

public WavesetResult delete()
Deprecated. 

find

public abstract java.util.List find(java.lang.String attrName,
                                    java.lang.String value,
                                    int maxToFind,
                                    boolean contains)
                             throws IAPI.IAPIException
Deprecated. 
Find the first maxToFind entries that match the parameters. Must be overridden to fill in the type.

Parameters:
attrName - - the attribute name to search on. See ...
value - - the value of the named attribute
contains - - true: match any that contain value. false match only those that equal value
Returns:
the list of matches. A List of String objects that can be used to create a resource event.
Throws:
IAPI.IAPIException

find

public abstract java.util.List find(java.util.List attrNames,
                                    java.util.List values,
                                    java.util.List conditions,
                                    int maxToFind)
                             throws IAPI.IAPIException
Deprecated. 
Throws:
IAPI.IAPIException

getElementName

public java.lang.String getElementName()
Deprecated. 
Description copied from class: AbstractXmlObject
Return the element name.

Specified by:
getElementName in interface XmlObject
Specified by:
getElementName in class AbstractXmlObject

addXmlHeader

public static void addXmlHeader(java.lang.StringBuffer b,
                                java.lang.String element)
Deprecated. 
Adds a standard XML header, DOCTYPE statement and element start tag. This is typically called by the toXml method above prior to calling the toXml method of a subclass. Subclasses may also call it if they want to overload the generation of the header or DOCTYPE for some reason, though there should be no reason to do so.


toXml

public java.lang.String toXml()
Deprecated. 
Serialize the object to an XML string.

The default implementation is to create a string buffer, add an XML header and call the toXml(StringBuffer) method. This may be overloaded by the subclasses, though there is usually no need to.

Specified by:
toXml in interface XmlObject
Overrides:
toXml in class AbstractXmlObject

toXml

public void toXml(java.lang.StringBuffer b)
Deprecated. 
Serialize the object as XML into a string buffer. PersistentObject's implementation provides a standard template for its concrete subclasses.

NOTE: Each subclass should serialize any necessary fields specific to that subclass.

Overrides:
toXml in class AbstractXmlObject

toXml

public void toXml(java.lang.StringBuffer b,
                  int indent)
Deprecated. 
Serialize the object as XML with an optional indentation. This is the one XmlObject wants to have defined, persistent objects should implement this, but its too late now. Since they're usually at top level anyway, it doesn't hurt much.

Specified by:
toXml in interface XmlObject
Specified by:
toXml in class AbstractXmlObject

getRequiredAttributeNames

public java.util.Set getRequiredAttributeNames()
Deprecated. 
Returns:
a list containing the names of required attributes. This will be used to fetch attributes from a resource and build an attribute map, or just to validate that everything that we need is in the map.

Subclasses should override this and call super() to add attributes names to the list.


getOptionalAttributeNames

public java.util.Set getOptionalAttributeNames()
Deprecated. 
Returns:
a list containing the names of optional attributes. This will be used to fetch attributes from a resource and build an attribute map. Subclasses should override this and call super() to add attribute names to the complete list.

getSubject

public Subject getSubject()
Deprecated. 

setAttributeNamespace

public void setAttributeNamespace(java.lang.String name)
Deprecated. 
incoming attributes from the active sync adapter will be put in this named object in the view. Was global but that can cause problems with readonly attributes. Now defaults to activeSync


getAttributeNamespace

public java.lang.String getAttributeNamespace()
Deprecated. 

setNoGlobalAattributes

public void setNoGlobalAattributes(boolean val)
Deprecated. 

getNoGlobalAattributes

public boolean getNoGlobalAattributes()
Deprecated. 

setLogger

public void setLogger(java.lang.Object logger)
Deprecated. 
Parameters:
logger - The logger to set.

throwIAPIException

protected static void throwIAPIException(java.lang.Throwable th)
                                  throws IAPI.IAPIException
Deprecated. 
Map any throwable from the "real" IAPI back to a com.waveset.object.IAPI$IAPIException (or to a RuntimeException).

Throws:
IAPI.IAPIException

throwWavesetException

protected static void throwWavesetException(java.lang.Throwable th)
                                     throws WavesetException
Deprecated. 
Map any throwable from the "real" IAPI back to a com.waveset.util.WavesetException (or to a RuntimeException).

Throws:
WavesetException