SOA-2: OpenEdge® 10.1A Adapters for SonicMQ® New Install, New Architecture, and New APIs Cheryl...

SOA-2: OpenEdge® 10.1A Adapters for SonicMQ®New Install, New Architecture, and New APIs

Cheryl LaBargeSenior Training Program Manager

© 2006 Progress Software Corporation2SOA-2: OpenEdge 10.1A Adapters for SonicMQ

Agenda

New Install Now Supporting JMS 1.1 New Architecture New APIs Error Handling

This presentation includes annotations with additional complementary information. API reference details are supplied in the notes for each slide.

OpenEdge 10.1A Adapters for SonicMQ


MQ Client

New Install – A Symbiotic Process

OpenEdge10.1A Connections to Sonic 6.1• SonicMQ 6.1 Client included on OpenEdge

Media

• SonicMQ 6.1 Client “Silent Install” to OpenEdge directory

– Offline.bat or Offline.sh to install later

A component no longer a product


Agenda




Prior to 10.1A

Two different sessions• Queue

• TopicRUN jms/pubsubsession.p.

RUN jms/ptpsession.p.

JMS 1.0


Example - Prior to 10.1A

DEFINE VARIABLE ptpsession AS HANDLE NO-UNDO.

DEFINE VARIABLE hMsg AS HANDLE NO-UNDO.

DEFINE VARIABLE cText AS CHARACTER

INITIAL “PTPsession ONLY" NO-UNDO.

RUN jms/ptpsession.p PERSISTENT SET ptpsession

("-H OEServer -S 5162").

RUN setBrokerURL IN ptpsession (“tcp://MQBrokerHost:2506”).

RUN beginSession IN ptpsession.

RUN sendToQueue IN ptpsession

("SampleQ1", hMsg, ?, ?, ?).

RUN deleteSession IN ptpsession.

Point to Point Session

Sends to Queue

Prior to 10.1A - Create a ptp session object


10.1A - Combination of PTP and Pub/Sub

New in 10.1A• Parent containing all APIs

All new code should use jmssession.p!!!

RUN jms/jmssession.p.

JMS 1.1 Unified Domain Model


DEFINE VARIABLE hSession AS HANDLE NO-UNDO.

DEFINE VARIABLE hMsg AS HANDLE NO-UNDO.

DEFINE VARIABLE cText AS CHARACTER

INITIAL “Unified JMSsession" NO-UNDO.

RUN jms/jmssession.p PERSISTENT SET hSession

("-H myMachine -S 5162").

RUN setBrokerURL IN hSession (“tcp://:2506").

RUN sendToQueue IN hSession

("SampleQ1", hMsg, ?, ?, ?).

RUN publish IN hSession ("Topic1", hMsg, ?, ?, ?).

RUN deleteMessage IN hMsg.

RUN deleteSession IN hSession.

Example - Unified Session in 10.1A

Using a single session handle

One session handle can send to queues AND publish to topics


Demonstration – Unified SessionSampleQ1

Topic1

Using Sonic JMS Test Client to view messages


Agenda




Architecture

Prior to 10.1A• OpenEdge Adapter for SonicMQ

OpenEdge 10.1A Connection Modes• BrokerConnect

• ClientConnect

• ServerConnect

OpenEdge Adapter for SonicMQ


Example - BrokerConnect

Prior to 10.1A• Separate

processes– OpenEdge

Adapter – Client

Still available in 10.1A


("-H OEServer -S 5162“).

RUN setBrokerURL IN hSession(“tcp://MQBrokerHost:2506").

RUN beginSession IN hSession .


Example - ClientConnect

SonicMQ ClientConnect• Single Process -

OpenEdge Adapter & Client

• AdminServer & NameServer no longer needed


(“-SMQConnect").

RUN setBrokerURL IN hSession(“tcp://MQBrokerHost:2506").

RUN beginSession IN hSession.


Example - ServerConnect

MQ-ServerConnect


Logging

ClientConnect logging disabled by default• JavaTools.properties

– brkLogginglevel– srvrLogginglevel

ServerConnect• Similar to 10.0A logging

• New page on AppServer and WebSpeed Agents


Limitations of BrokerConnect

Feature BrokerConnect ClientConnect ServerConnect

Unified Domain Yes Yes Yes

Client Persistence No Yes Yes

Fault Tolerance No Yes Yes

Message Selectors Yes Yes Yes

Serialized Connection Objects No Yes Yes

TemporaryQueues and Topics Yes Yes Yes

BrokerConnect cannot take advantage of certain features


Agenda




New and Enhanced APIs

Client Message Persistence Fault Tolerant Client Connections Serialized Connection Objects Enhanced XML support Temp Table messages DataSet messages Temporary Destinations Server Based Message Selectors


Client Persistence

Allows applications to continue to send/publish messages when MQBroker connection is lost

Rechecking at set intervals

Messages are sent from local store (directory) when a connection is reestablished

Available only with new connection modes


Steps to Use Client Persistence

1. Create the session object

2. Use new client persistence APIs

3. Begin the session

4. Send/receive messages– If SonicMQ Broker unavailable,

messages sent will be persisted


1. Create Session Object


("-SMQConnect").

RUN setBrokerURL IN hSession ("localhost:2506").

RUN SETUSER IN hSession ("Administrator").

RUN setPassword IN hSession("Administrator").

/* Client Persistence Requires a Client ID */

RUN setClientID IN hSession ("TestClientPersistence999").

Client Persistence Requires an ID

Type Name Parameters\Returns

Procedure setClientID INPUT clientID AS CHAR

Standard Steps…Except …


Set/Get• Local Store Directory

• Local Store Size

• Reconnect Timeout

• Reconnect Interval

• Client Persistence

2. Use New Client Persistence APIs

New APIs


Local Store Directory

Directory to persist messages


Procedure setLocalStoreDirectory INPUT localStoreDir AS CHAR

Function getLocalStoreDirectory RETURNS CHAR

• Default, current working directory

– C:\OpenEdge\WRK

• Before beginSession


Local Store Size

Maximum File Size

• Default 10,000(KB)



Procedure setLocalStoreSize INPUT storeSize AS INTEGER

Function getLocalStoreSize RETURNS INTEGER


Reconnect Timeout

How long will it keep trying to reconnect

• Default 0 Minutes = No limit



Procedure setReconnectTimeout INPUT timeout AS INTEGER

Function getReconnectTimeout RETURNS INTEGER


Reconnect Interval

Time between attempts

• Default 30 Seconds



Procedure setReconnectInterval INPUT interval AS INTEGER

Function getReconnectInterval RETURNS INTEGER

QUESTION:What happens if you give up?

ANSWER: Messages stay in local store.

ANSWER: No, you can crack the local message open “just to look”!


Client Persistence

Enable the client side property

• Default False



Procedure setClientPersistence INPUT enabled AS LOGICAL

Function getClientPersistence RETURNS LOGICAL


Create Rejected Message Consumer

Handles all rejected message

• After beginSession

Name Parameters

createRejectedMessageConsumer INPUT procHandle AS HANDLE

INPUT procName AS CHAR

OUTPUT consumerHandle AS HANDLE


Example - Using the New APIs

/* local store directory relative to cwd */RUN setLocalStoreDirectory IN hSession ("mqstore").RUN setLocalStoreSize IN hSession (50000)./* Give up if broker down 10 hours */RUN setReconnectTimeout IN hSession (600)./* Retry every minute */RUN setReconnectInterval IN hSession (60)./* set Client Persistence */RUN setClientPersistence IN hSession (TRUE)./* Note CreateRejectedMessageConsumer must be done *//* AFTER BeginSession. You will see this later */


3. Example - Begin the Session

RUN beginSession IN hSession./*After beginSession, createRejectedMessageConsumer*/RUN createRejectedMessageConsumer

IN hSession (INPUT THIS-PROCEDURE, INPUT "RejectedMsgHandler", OUTPUT HrejectedMsg).

Standard Steps…plus calling new API


Demonstration4a. Send Messages

Start • SendToQueue Window• Send “This is the first Message”

Stop Container1 Notice: Client shows no signs of lost

connection Send 4 more messages Restart Container1

• Persistent client will send to Queue by collecting from mqstore


4b. Receive Messages

Start JMS Test Client to receive all messages

Seeing is believing


New and Enhanced APIs – By Concepts



Domain

What is Fault Tolerance?

Container1

Broker1

Directory Service

JNDI Store

Agent Manager

DomainManager

PrimaryContainer

PrimaryBroker*

PrimaryBackupContainer

PrimaryBackupBroker*

Replication Connection(s)

*Requires CAA Licensing

Defining backup broker to pickup if primary broker fails


SonicMQ Broker • Must be licensed for Fault Tolerance

• Primary and Backup Broker must be configured and tested

ABL Client can Set/Get• Fault Tolerance

• Client Transaction Buffer Size

• Initial Connection Timeout

• Reconnect Timeout

Using Fault Tolerant Client ConnectionsAvailable only with new connection modes


Fault Tolerant Client Connections

Enable/Disable Fault Tolerance

• Before beginSession• Default is FALSE


Procedure setFaultTolerant INPUT enable AS LOGICAL

Function getFaultTolerant RETURNS LOGICAL


Client Transaction Buffer Size

Client Transaction Buffer Size


• Maximum buffer size for transactions

• Default 0 Bytes. If 0, it will use SonicMQ Broker defined value instead


Procedure setClientTransactionBufferSize INPUT CTBuffer AS INTEGER

Function getClientTransactionBufferSize RETURNS INTEGER



Initial Connection Timeout


• Time to wait for initial connection to broker

• Seconds, default 30


Procedure setInitialConnectionTimeout INPUT FTInitTimeout AS INTEGER

Function getInitialConnectionTimeout RETURNS INTEGER



Reconnect Timeout


• Time to attempt to reconnect to broker

• Seconds, default 60


Procedure setFaultTolerantReconnectTimeout INPUT PARAMETER

FTReconnect AS INTEGER

Function getFaultTolerantReconnectTimeout RETURNS INTEGER


Fault Tolerant Example

DEFINE VARIABLE hSession AS HANDLE.RUN jms/jmssession.p PERSISTENT

SET hSession ("-SMQConnect").RUN setConnectionURLs IN hSession("Primary:2508,BackupServer:9876”).RUN setFaultTolerant IN hSession(TRUE)./***************************************************Default valuesClientTransactionBufferSize,0 bytes defaults to SonicInitialConnectionTimeout, 30 seconds FaultTolerantReconnectTimeout, 60 seconds ****************************************************/RUN beginSession IN hSession.RUN createChangeStateConsumer IN hSession

(THIS-PROCEDURE, "msgHandler", OUTPUT msgH).



Verify Broker is licensed for Fault Tolerance


• Default Disabled (FALSE)

Notify Application of lost Broker connection


• Optional, default is not to notify



Function isFaultTolerant RETURNS LOGICAL


Procedure createChangeStateConsumer INPUT procHandle AS HANDLE

INPUT procName AS CHAR

OUTPUT consumerHandle

AS HANDLE


Change State Consumer

PROCEDURE msgHandler: DEFINE INPUT PARAMETER hMessage AS HANDLE. DEFINE INPUT PARAMETER hMsgConsumer AS HANDLE. DEFINE OUTPUT PARAMETER hReply AS HANDLE. DEFINE VAR val AS CHAR NO-UNDO. val = DYNAMIC-FUNCTION

("getCharProperty" IN hMessage, "state"). /* val is "active", "reconnecting", "failed", or "closed" */ DISPLAY val. RUN deleteMessage IN hMessage.END.





Example - Serialized Connection Objects

Define file that contains connection data

You can replace

WithRUN setConnectionFile IN hSession

(“connectionfilename”).

RUN setBrokerURL IN hSession ("localhost:2506").

RUN SETUSER IN hSession ("Administrator").

RUN setPassword IN hSession("Administrator").

Type Name Parameters

Procedure setConnectionFile INPUT filename AS CHARACTER



Stores All Default Connection Information

Created by Sonic Administrator

Sonic Administrator completes:

•Lookup Name

•Connection URL

•Default User Name

•Default Password

•Confirm Password

WARNING: Always use machine

names or

IP addresses.

Localhost used

here for generic demo





XML Support

Provides easier integration between SonicMQ and OpenEdge• Create an XML message

– Use the X-DOCUMENT handle

or

– Use the SAX-Writer

• Receive an XML Message– Use the X-DOCUMENT handle

or

– Use the SAX-Reader

Additional APIs added to the XMLMessage Object


X-Document• Copy XML document into XML message

• Copy XML message into XML document

XML Support - DOM


Function getX-Document RETURNS HANDLE


Procedure setX-Document INPUT HXMLFile AS HANDLE



Example - XML Support - DOM

RUN createXMLMessage IN hSession

(OUTPUT hMsg).

CREATE x-document hXDOC.

hXDOC:LOAD("file", “myCustom.xml", false).

RUN setX-Document IN hMsg (hXDOC).


("SampleQ1", hMsg, ?, ?, ?).

RUN deleteMessage IN hMsg.



XML Support – Sending with a SAX-Writer

SAX-Writer• Create SAX-Writer handle

• Output destination internal longchar

– Example

hSAXWriter = DYNAMIC-FUNCTION

('getSaxWriter':U IN hMsg, ?)


Function getSaxWriter INPUT Name CHAR

RETURNS HANDLE



XML Support – Sending with a SAX-Writer

SAX-Writer• Delete SAX-Writer handle

– ExampleRUN deleteSaxWriter IN hMsg (hSAXWriter).


Procedure deleteSaxWriter INPUT swhandle AS HANDLE



Returns SonicMQ message type

Checking Message Type


Function getMessageType RETURNS CHAR

Now Includes:

•DataSetMessage

•TempTableMessage

Message Type


Example - XML Support: Receiving with SAX-Reader

Sax-Reader

• Input destination internal longchar– Example

CREATE SAX-READER hSAXReader.

RUN setSaxReader IN hMsg (hSAXReader).

hSAXReader:SAX-PARSE().

DELETE OBJECT hSAXReader.


Procedure setSaxReader INPUT hSaxReader AS HANDLE



Example - Deleting Message

RUN deleteMessage IN hMsg. /* Stop receiving messages */ RUN stopReceiveMessages IN hSession.





Temp Table Messages

Allow applications to send and receive • Temp-Tables as XML messages to SonicMQ

SonicMQ Adapter • Converts Temp-Tables to/from XML

SonicMQ• Handles as an XML message

New APIs


Create Temp-Table Message

Send Temp-Table to XML Message

Create and Send a Temp-Table as an XML Message


Procedure createTempTableMessage OUTPUT HMessage AS HANDLE


Procedure setTempTable INPUT hTable AS HANDLE

INPUT SchemaLocation AS CHAR

INPUT writeSchema AS LOGICAL


Example - Create and Send a Temp-Table as an XML Message

DEFINE VARIABLE HSession as HANDLE NO-UNDO.DEFINE VARIABLE HMsg as HANDLE NO-UNDO.DEFINE VARIABLE TempTable tcust LIKE customers

NO-UNDO. /* create temp table records .. */RUN createTempTableMessage in HSession

(OUTPUT HMsg). RUN setTempTable IN HMsg (tcust, ?, TRUE).RUN sendToQueue IN Hsession

("SampleQ1", HMsg, ?, ?, ?)..


Read XML Message into Temp-Table

Receiving Temp Table Messages


Function getTempTable INPUT TTname AS CHAR

INPUT SchemaLocation AS CHAR

INPUT FieldTypeMap AS CHAR

RETURNS HANDLE


Example – Receiving Temp Tables

DEFINE VARIABLE mtype AS CHAR NO-UNDO.mtype = DYNAMIC-FUNCTION

('getMessageType':u IN hMsg).MESSAGE "MTYPE is " mType VIEW-AS ALERT-BOX.

IF mtype = "TempTableMessage" THEN DO: MESSAGE “A table message" VIEW-AS ALERT-BOX. hTempttItem = DYNAMIC-FUNCTION

('getTempTable':u IN hMsg, ?, ?, ?). httItem:COPY-TEMP-TABLE( hTempttItem ) . /* TempTable actions as needed */ {&OPEN-BROWSERS-IN-QUERY-{&FRAME-NAME}} DELETE OBJECT hTempttItem. END.





Send a ProDataSet as an XML Message to SonicMQ

DataSet Messages

Allow applications to send and receive ProDataSets as XML messages to SonicMQ

SonicMQ Adapter • Converts ProDataSet to/from XML

SonicMQ• Handles as an XML message


DataSet Messages

Create DataSet Message

Send ProDataSet to XML Message


Procedure createDataSetMessage OUTPUT HMessage HANDLE


Procedure setDataSet INPUT HDataSet AS HANDLE

INPUT schemaLocation AS CHAR

INPUT writeSchema AS LOGICAL


Example - DataSet Messages

DEFINE VARIABLE HSession as HANDLE NO-UNDO.DEFINE VARIABLE HMsg as HANDLE NO-UNDO.DEFINE VARIABLE HDataSet AS HANDLE NO-UNDO. /* define DataSet etc etc.. */RUN createDataSetMessage in HSession

(OUTPUT HMsg). RUN setDataSet IN HMsg

(HDataSet, ?, TRUE).RUN sendToQueue IN Hsession

("SampleQ1", HMsg, ?, ?, ?).


DataSet Messages

Read XML message into ProDataSet


Function getDataSet INPUT HDataSet

INPUT schemaLocation

INPUT fieldTypeMap

RETURNS HANDLE

Receive an XML Message into a ProDataSet from SonicMQ


Example - Receiving a ProDataSet

IF mtype ="DatasetMessage" THEN DO: RUN PurgeDataset. /* returns dynamic dataset */ hTempdsOrder = DYNAMIC-FUNCTION

('getDataSet':u IN hMsg, ?, ?, ?). /* dumps the dynamic one into static dsOrder */ hdsOrder:COPY-DATASET( hTempdsOrder ) . RUN DisplayDataSetDetails. DELETE OBJECT hTempDSOrder.END.


Enhanced APIs

Temp-Table and DataSet messages• Reset message to read-only

• Change Mode to write-only

• Delete Temp-Table or DataSet Message too


Procedure

reset N\A


Procedure

clearBody N\A


Procedure deleteMessage N\A

Existing APIs now support


Demonstration

Serialized Connection Object Enhanced XML support Temp Table messages DataSet messages





Temporary Destinations

Allow applications to create temporary queues and topics Queue

Topic


Procedure createTemporaryQueue OUTPUT OPtempQname AS CHAR


Procedure createTemporaryTopic OUTPUT OPtempTname AS CHAR

createTemporaryQueue & createTemporaryTopic


Temporary Destinations

Delete when no longer needed Release resources

• Delete message consumer object • Then delete temporary queue or topic

Queue

Topic


Procedure deleteTemporaryQueue INPUT IPtempQname AS CHAR


Procedure deleteTemporaryTopic INPUT IPtempTname AS CHAR

deleteTemporaryQueue & deleteTemporaryTopic


Example - Temporary Queues and Topics

RUN createTemporaryQueue IN hSession

(OUTPUT cTempQueue).

RUN createTemporaryTopic IN hSession

(OUTPUT cTempTopic).

MESSAGE "The temporary Queue is called " SKIP

cTempQueue SKIP

"The temporary Topic is called " SKIP

cTempTopic VIEW-AS ALERT-BOX.


(cTempQueue, hMsg, ?, ?, ?).

RUN publish IN hSession

(cTempTopic, hMsg, ?, ?, ?).

RUN deleteTemporaryQueue IN hSession

(OUTPUT cTempQueue).

RUN deleteTemporaryTopic IN hSession

(OUTPUT cTempTopic).





Server Based Message Selectors

Messages filtered on defined criteria

Prior to 10.1A • Point-to-Point

– Message filter on SonicMQ Broker

• Publish/Subscribe– Message filter on SonicMQ Client

New in 10.1A • Ability to move message filter to SonicMQ Broker

New APIs - Available with all connection modes


Server Based Message Selectors

Return current message filter setting

• Default False Using server based message selection

RUN setSelectorAtBroker IN HSession (TRUE).


Procedure setSelectorAtBroker INPUT enable AS LOGICAL

Function getSelectorAtBroker RETURNS LOGICAL

New APIs - Available with all connection modes


Agenda




Error Handling

Types of Errors• Deployment/Administration errors

• Runtime errors– Client errors – before request is made– Client errors – making request– Server errors – while processing request

Available Debugging Tools• SOAP Message Viewers (SOAP Faults)

• Log Files / Logging Levels


Where to Look for Errors

SOAP Fault response message• Client can catch the exception and look at it

programmatically• Use SOAP Message Viewer

Log Files• JSE log file• WSA log file: *.wsa.log• AdminServer log file: admserv.log• AppServer log file: *.server.log, *.ns.log• SonicMQ ClientConnect log file: cc.broker*.log,

cc.server*.log• SonicMQ ServerConnect log file: sc.broker*.log,

sc.server*.log


In Summary

Adapters for SonicMQ are a component in every OpenEdge install that you can use today

All connections support JMS 1.1 New connections support new APIs

CONSUMER subscribe, receive

JMS 1.1 Messages Destination

PRODUCER publish, send

Broker

MQ Client

APIs

ClientConnect

ServerConnect


For More Information, go to…

Codes samples available at • http://psdn.progress.com

• Keyword – Exchange

PSDN



Introductory• SOA3: Getting the message, so you need to

integrate, but what do you need to know and do?

Architecture• ARCH-7: Integrate this! SonicMQ and the

OpenEdge Reference Architecture

New in Sonic 7.0 • SOA4: Introducing Sonic SOA Suite v7.0

Relevant SonicMQ Sessions



XML• DEV-11: Leveraging ProDataSets in an Open

Environment

• DEV 15: XML in OpenEdge − Past, Present and Future

• INNOV-10: An Introduction to XQuery by Example

Relevant XML Exchange Sessions


Updated OpenEdge Documentation

Getting Started• Application & Integration Services• Installation & Configuration Guides• Core Services

Development• Programming for the OpenEdge Adapter for

SonicMQ with the 4GL-JMS API

Application Server• Administration


Hands On Training

http://www.progress.com/services/education/index.ssp


Questions?


Thank you foryour time


Date post:	29-Dec-2015
Category:	Documents
Upload:	beatrice-dixon
View:	256 times
Download:	1 times

SOA-2: OpenEdge® 10.1A Adapters for SonicMQ® New Install, New Architecture, and New APIs Cheryl...

Documents