Package org.apache.camel.component.jt400
Class Jt400Configuration
java.lang.Object
org.apache.camel.component.jt400.Jt400Configuration
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumEnumeration of supported data formatsstatic enumstatic enumSearchTypes for reading from Keyed Data Queues -
Constructor Summary
ConstructorsConstructorDescriptionJt400Configuration(String endpointUri, com.ibm.as400.access.AS400ConnectionPool connectionPool) -
Method Summary
Modifier and TypeMethodDescriptionintgetCcsid()com.ibm.as400.access.AS400Obtains anAS400object that connects to this endpoint.intgetCssid()Returns the CCSID to use for the connection with the IBM i system.Returns the data format for sending messages.Returns the fully qualified integrated file system path name of the target object of this endpoint.Integer[]Integer[]Returns the password of the IBM i user.intReturns the name of the IBM i system.getType()Returns the ID of the IBM i user.booleanReturns whether IBM i prompting is enabled in the environment running Camel.booleanisKeyed()booleanbooleanvoidreleaseConnection(com.ibm.as400.access.AS400 connection) Releases a previously obtainedAS400object from use.voidsetCcsid(int ccsid) Sets the CCSID to use for the connection with the IBM i system.voidsetFieldsLength(String fieldsLength) voidsetFormat(Jt400Configuration.Format format) Sets the data format for sending messages.voidsetGuiAvailable(boolean guiAvailable) Sets whether IBM i prompting is enabled in the environment running Camel.voidsetKeyed(boolean keyed) Whether to use keyed or non-keyed data queues.voidsetMessageAction(Jt400Configuration.MessageAction messageAction) Action to be taken on messages when read from a message queue.voidsetObjectPath(String objectPath) voidsetOutputFieldsIdx(String outputFieldsIdx) voidsetOutputFieldsIdxArray(Integer[] outputFieldsIdxArray) Specifies which fields (program parameters) are output parameters.voidsetOutputFieldsLengthArray(Integer[] outputFieldsLengthArray) Specifies the fields (program parameters) length as in the IBM i program definition.voidsetPassword(String password) voidsetProcedureName(String procedureName) Procedure name from a service program to callvoidsetReadTimeout(int readTimeout) Timeout in millis the consumer will wait while trying to read a new message of the data queue.voidsetSearchKey(String searchKey) Search key for keyed data queues.voidsetSearchType(Jt400Configuration.SearchType searchType) Search type such as EQ for equal etc.voidsetSecured(boolean secured) Whether connections to IBM i are secured with SSL.voidsetSendingReply(boolean sendingReply) If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received.voidsetSystemName(String systemName) voidWhether to work with data queues or remote program callvoid
-
Constructor Details
-
Jt400Configuration
public Jt400Configuration(String endpointUri, com.ibm.as400.access.AS400ConnectionPool connectionPool) throws URISyntaxException - Throws:
URISyntaxException
-
-
Method Details
-
getType
-
setType
Whether to work with data queues or remote program call -
getSystemName
Returns the name of the IBM i system. -
setSystemName
-
getUserID
Returns the ID of the IBM i user. -
setUserID
-
getPassword
Returns the password of the IBM i user. -
setPassword
-
getObjectPath
Returns the fully qualified integrated file system path name of the target object of this endpoint. -
setObjectPath
-
getCssid
public int getCssid()Returns the CCSID to use for the connection with the IBM i system. Returns -1 if the CCSID to use is the default system CCSID. -
setCcsid
public void setCcsid(int ccsid) Sets the CCSID to use for the connection with the IBM i system. -
getFormat
Returns the data format for sending messages. -
setFormat
Sets the data format for sending messages. -
isGuiAvailable
public boolean isGuiAvailable()Returns whether IBM i prompting is enabled in the environment running Camel. -
setGuiAvailable
public void setGuiAvailable(boolean guiAvailable) Sets whether IBM i prompting is enabled in the environment running Camel. -
getCcsid
public int getCcsid() -
isKeyed
public boolean isKeyed() -
setKeyed
public void setKeyed(boolean keyed) Whether to use keyed or non-keyed data queues. -
getSearchKey
-
setSearchKey
Search key for keyed data queues. -
getSearchType
-
setSearchType
Search type such as EQ for equal etc. -
getOutputFieldsIdxArray
-
isSecured
public boolean isSecured() -
setSecured
public void setSecured(boolean secured) Whether connections to IBM i are secured with SSL. -
setOutputFieldsIdxArray
Specifies which fields (program parameters) are output parameters. -
getOutputFieldsLengthArray
-
setOutputFieldsLengthArray
Specifies the fields (program parameters) length as in the IBM i program definition. -
getReadTimeout
public int getReadTimeout() -
setReadTimeout
public void setReadTimeout(int readTimeout) Timeout in millis the consumer will wait while trying to read a new message of the data queue. -
getProcedureName
-
setProcedureName
Procedure name from a service program to call -
getMessageAction
-
setMessageAction
Action to be taken on messages when read from a message queue. Messages can be marked as old ("OLD"), removed from the queue ("REMOVE"), or neither ("SAME"). -
isSendingReply
public boolean isSendingReply() -
setSendingReply
public void setSendingReply(boolean sendingReply) If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received. If that message is then routed to a producer endpoint, the action will not be processed as sending a message to the queue, but rather a reply to the specific inquiry message. -
setOutputFieldsIdx
-
setFieldsLength
-
getConnection
public com.ibm.as400.access.AS400 getConnection()Obtains anAS400object that connects to this endpoint. Since these objects represent limited resources, clients have the responsibility ofreleasing themwhen done.- Returns:
- an
AS400object that connects to this endpoint
-
releaseConnection
public void releaseConnection(com.ibm.as400.access.AS400 connection) Releases a previously obtainedAS400object from use.- Parameters:
connection- a previously obtainedAS400object to release
-