|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FILEClient
Field Summary | |
---|---|
static java.lang.String |
DELETEREF
The custom script can refrain from deleting the referenced source by setting this slot to the value 'false' (this is if the framework transport is not configured to remove the reference). |
static java.lang.String |
DOCUMENTID
The document ID of the message. |
static java.lang.String |
HOSTNAME
The host name |
static java.lang.String |
LOG_OBJ
The log client extension handle for custom scripts to log. |
static java.lang.String |
MSGOBJECT
If the payload exists in memory and therefore it is not referenced by a filename, this slot holds the object, which can be retrieved through the method get("dataObj"). |
static java.lang.String |
OPERATIONID
The operation ID of the message. |
static java.lang.String |
SRCFILENAME
The file name used for outbound referenced payload. |
static java.lang.String |
SRCFILEPATH
The file path used for outbound referenced payload. |
static java.lang.String |
SRCFILEURL
The transport url for outbound referenced payload. |
static java.lang.String |
TPNAME
The partner name |
static java.lang.String |
TRANSACTIONID
The transaction ID of the message. |
static java.lang.String |
USERSTATUSCODE
The custom script can return a status code in this slot. |
static java.lang.String |
USERSTATUSMSG
The custom script can return a status message in this slot. |
Method Summary | |
---|---|
void |
aeTrace(java.lang.String role,
java.lang.String msgcode,
java.lang.String desc,
java.lang.String trackingInfo)
Send information to the BusinessConnect log. |
java.lang.Object |
get(java.lang.String prop)
|
IClientObject |
getClientObject()
Retrieve a client object, which can provide more context specific information about the transaction. |
java.lang.String |
getName()
Retrieve the name of the file client instance. |
java.lang.String |
getUserStatusCode()
Get the specified status code |
java.lang.String |
getUserStatusMsg()
Get the specified status message |
void |
put(java.lang.String prop,
boolean del)
Regardless of the prop value, set the 'DELETEREF' slot to the value of 'del' |
void |
put(java.lang.String prop,
java.lang.Object value)
|
Field Detail |
---|
static final java.lang.String LOG_OBJ
static final java.lang.String SRCFILEPATH
static final java.lang.String SRCFILENAME
static final java.lang.String SRCFILEURL
static final java.lang.String TPNAME
static final java.lang.String HOSTNAME
static final java.lang.String OPERATIONID
static final java.lang.String TRANSACTIONID
static final java.lang.String DOCUMENTID
static final java.lang.String MSGOBJECT
static final java.lang.String DELETEREF
static final java.lang.String USERSTATUSCODE
static final java.lang.String USERSTATUSMSG
Method Detail |
---|
java.lang.Object get(java.lang.String prop)
void put(java.lang.String prop, java.lang.Object value)
void put(java.lang.String prop, boolean del)
void aeTrace(java.lang.String role, java.lang.String msgcode, java.lang.String desc, java.lang.String trackingInfo)
role
- any of the values "INFO", "ERROR", "WARN", "DEBUG".msgcode
- any message code that the script may want to return, e.g. 200.desc
- any message describing the event, e.g. "Message has been sent successfully."trackingInfo
- any optional info to track/identify the event, e.g. an identifier of
the business message. May be null or empty.java.lang.String getName()
java.lang.String getUserStatusCode()
java.lang.String getUserStatusMsg()
IClientObject getClientObject()
IClientObject
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |