Destination properties available at runtime
May 16, 2011
Posted by on
In my last blog post I mentioned that there were various properties available when you create your own BlazeDS / LiveCycle DS destination at runtime. The properties available to you are based on which type of adapter you are using.
Each set of properties is baked into a ConfigMap instance that you pass to the initialize() method of the adapter. In my research, I’ve found that there are some adapters that fire up ok without any properties defined (these tend to be the open-source ones), and some which cause all sorts of issues unless you have certain magical properties defined (these tend to be the closed-source ones).
In addition to the regular properties, there are also “ServerSettings” and “NetworkProperties”, which are not covered here. By not setting those properties, your destination will assume the defaults.
So, what are the available properties that you can set? Below is a list of the service/adapter/properties:
- remoting-service (used for Flash Remoting, Remote Object connections, and “AMF” connections)
- ColdFusionAdapter “cf-object” (used to connect AMF messages to CFCs)
- access (as ConfigMap)
- use-mappings (true/false) ***
- method-access-level (“public”/”remote”) ***
- property-case (as ConfigMap)
- force-cfc-lowercase (true/false)
- force-query-lowercase (true/false)
- use-accessors (true/false)
- use-structs (true/false)
- Java Adapter “java-object” (used to connect AMF messages to Java classes)
- include-methods (if defined, this is the list of methods that are allowed to be called)
- exclude-methods (a list of methods that are blocked from being called. do not use with include-methods)
- messaging-service (used for realtime messaging applications)
- cfgateway (used to have ColdFusion mediate messages on the destination)
- gatewayid (the dot-location to the cfc that will handle the message) ***
- gatewayhost (used to define which host is hosting the cfcs, if it is not localhost — for example if your BlazeDS server is different from your CF server)
- allowedIPs (which servers are allowed send data onto the destination back to the clients)
- remote-username (bakes in this username into all the packets sent to CF)
- remote-password (bakes in this password into all the packets sent to CF)
- (there are no properties for ActionScript. Send in an empty ConfigMap)
- jms (as ConfigMap)
There are also services for proxying and data-management, however I’ve never used them (well, I have used data-management a lot, but since the licensing changes to LCDS, it’s pretty much dead to me). I don’t know much about the jms adapter, so I can’t really say what all the properties mean, but I do know they are there.
I have marked some properties with a ***. If you see that, you need to include it, or you will get varied results in creating the destination at runtime (most likely, it will fail the first time you send data to it, rather when you create it).