|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.waveset.util.AbstractXmlObject
com.waveset.object.IAPI
This class is preserved solely for backward-compatibility. It will not work unless the IDM server classes are available.
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 |
public static final java.lang.String code_id
protected static final Trace trace
protected static java.lang.Class _clIAPI
protected static java.lang.Class _clIAPIFactory
public static final java.lang.String ELEMENT
public static final java.lang.String COMMAND_CREATE
public static final java.lang.String COMMAND_UPDATE
public static final java.lang.String COMMAND_GET
public static final java.lang.String COMMAND_DELETE
public static final java.lang.String COMMAND_LIST
public static final java.lang.String OPTION_CREATE_IF_MISSING
public static final java.lang.String OPTION_REMOTE_ADMIN_NAME
public static final java.lang.String OPTION_DELETE_EVENT_DETECTED
public static final java.lang.String OPTION_FUTURE_DATA_WORKFLOW
public static final java.lang.String ATTRIBUTE_FUTURE_DATA
public static final java.lang.String ATTRIBUTE_FUTURE_DATA_EFFECTIVE_DATE
public static final java.lang.String ATTRIBUTE_FUTURE_DATA_WORKFLOW
public static final java.lang.String ATTRIBUTE_FUTURE_DATA_ATTRIBUTES
public static final int TRACE_LEVEL_NONE
public static final int TRACE_LEVEL_ERROR
public static final int TRACE_LEVEL_INFO
public static final int TRACE_LEVEL_WARNING
public static final int TRACE_LEVEL_DEBUG
public static final java.lang.String ATT_CHECKIN_OPTIONS
public static final java.lang.String ATT_CANCEL_OPTION
protected static final java.lang.String RA_PROXY_ADMINISTRATOR
protected static final java.lang.String RA_NAME
protected static final java.lang.String RA_FORM
protected static final java.lang.String RA_LOG_PATH
protected static final java.lang.String RA_LOG_SIZE
protected static final java.lang.String RA_LOG_LEVEL
protected java.lang.Object _objIAPI
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 |
public 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
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 namespacecommand
- 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).public IAPI(java.util.Map options, java.util.Map attributes, java.lang.String command, java.lang.String type, Resource source) throws IAPI.IAPIException
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).public IAPI(org.w3c.dom.Element e) throws WavesetException
Method Detail |
protected static java.lang.String getStringConstant(java.lang.String constantName, java.lang.String dflt)
public java.lang.String toString()
public static java.lang.String getApplicationName(java.lang.String raName)
public void setViewID(java.lang.String ID)
public java.lang.String getViewID()
public void setOptions(java.util.Map options)
public java.util.Map getOptions()
public void setAttributes(java.util.Map attributes)
public java.util.Map getAttributes()
public void setCommand(java.lang.String command)
public java.lang.String getCommand()
public void setType(java.lang.String type)
public java.lang.String getType()
public void setTraceLevel(int level)
level
- ignoredpublic int getTraceLevel()
public void setTraceFile(java.lang.String fullFilePath)
fullFilePath
- stored and ignoredpublic java.lang.String getTraceFile()
public void setProperty(java.lang.String name, java.lang.Object value)
public void removeProperty(java.lang.String name)
public java.lang.Object getProperty(java.lang.String name)
public int getRetryCount()
public int getRetryInterval()
public boolean traceLevelSet(int level)
level
- - if the trace level is >= level, return truepublic void traceString(int level, java.lang.String data, boolean addTimeStamp)
level
- - if the trace level is >= level, output the trace stringdata
- - string to outputaddTimeStamp
- - add a timestamp at the start of the bufferpublic void traceString(int level, java.lang.String data)
level
- - if the trace level is >= level, output the trace stringdata
- - string to outputpublic abstract WavesetResult submit()
public abstract WavesetResult getResult()
public abstract WavesetResult cancel()
public WavesetResult delete()
public abstract java.util.List find(java.lang.String attrName, java.lang.String value, int maxToFind, boolean contains) throws IAPI.IAPIException
attrName
- - the attribute name to search on. See ...value
- - the value of the named attributecontains
- - true: match any that contain value. false match
only those that equal value
IAPI.IAPIException
public abstract java.util.List find(java.util.List attrNames, java.util.List values, java.util.List conditions, int maxToFind) throws IAPI.IAPIException
IAPI.IAPIException
public java.lang.String getElementName()
AbstractXmlObject
getElementName
in interface XmlObject
getElementName
in class AbstractXmlObject
public static void addXmlHeader(java.lang.StringBuffer b, java.lang.String element)
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.
public java.lang.String toXml()
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.
toXml
in interface XmlObject
toXml
in class AbstractXmlObject
public void toXml(java.lang.StringBuffer b)
NOTE: Each subclass should serialize any necessary fields specific to that subclass.
toXml
in class AbstractXmlObject
public void toXml(java.lang.StringBuffer b, int indent)
toXml
in interface XmlObject
toXml
in class AbstractXmlObject
public java.util.Set getRequiredAttributeNames()
Subclasses should override this and call super() to add attributes names to the list.
public java.util.Set getOptionalAttributeNames()
public Subject getSubject()
public void setAttributeNamespace(java.lang.String name)
public java.lang.String getAttributeNamespace()
public void setNoGlobalAattributes(boolean val)
public boolean getNoGlobalAattributes()
public void setLogger(java.lang.Object logger)
logger
- The logger to set.protected static void throwIAPIException(java.lang.Throwable th) throws IAPI.IAPIException
IAPI.IAPIException
protected static void throwWavesetException(java.lang.Throwable th) throws WavesetException
WavesetException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |