Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can use the pinnedServers attribute to specify the list of Synapse servers where this proxy service should be deployed. If there is no pinned server list, the proxy service is started in all server instances. The pinnedServers attribute takes the Synapse server names separated by commas or spaces. The Synapse server name is specified in the system property SynapseServerName or through the axis2.xml parameter SynapseConfig.ServerName. If neither of these are set, the server hostname is used, or it defaults to localhost. You can give a name to a Synapse server instance by specifying the property -DSynapseServerName=<ServerName> when you execute the startup script wso2serverintegrator.bat or wso2serverintegrator.sh, or by editing wrapper.conf to do this where Synapse is started as a service.

...

Following are additional service parameters you can use:

Parameter

Value

Default

Description

useOriginalwsdl

true / false

false

If this parameter is set to true , the original WSDL published via the publishWSDL parameter is used. This WSDL would not be replaced by a WSDL generated by the proxy service.

Excerpt
hiddentrue

Modified the description to address the FAQ How can you make the proxy WSDL inaccessible/not visible for outside?

modifyUserWSDLPortAddress

true / false

true

(Effective only with useOriginalwsdl=true) If true (default) modify the port addresses to current host.

ApplicationXMLBuilder.allowDTDtrue / falsetrueIf this parameter is set to true, it enables data type definition processing for the proxy service.
Data type definition processing is disabled in the Axis2 engine due to security vulnerability. This parameter enables it for individual proxy services.

enablePublishWSDLSafeMode

true / false

true

When creating a proxy, if

If this parameter is set to true

, it prevents the proxy service deployment from failing when the wsdl is not available at server startup

when deploying a proxy service, even though the WSDL is not available, you can prevent the proxy service being faulty. However, the deployed proxy service will be unaccessible since the WSDL is not available.

Note

This is only applicable when you publish the WSDL (i.e., via the publishWSDL property) either as a URI or as an endpoint.

showAbsoluteSchemaURLtrue/falsetrueIf this parameter is set to true , the absolute path of the referred schemas of the WSDL is shown instead of the relative paths.
showProxySchemaURLtrue/false
 

If this parameter is set to true, the full proxy URL will be set as the prefix to the schema location of the imports in proxy WSDL.


The following service parameters are for specific transports:

Transport

Require

Parameter

Description

JMS

Optional

transport.jms.
ConnectionFactory

The JMS connection factory definition (from axis2.xml) to be used to
listen for messages for this service.

 


Optional

transport.jms.
Destination

The JMS destination name (Defaults to the service name).

 


Optional

transport.jms.
DestinationType

The JMS destination type. Accept values "queue" or "topic."

 


Optional

transport.jms.
ReplyDestination

The destination where a reply will be posted.

 


Optional

transport.jms.
Wrapper

The wrapper element for the JMS message.

VFS

Required

transport.vfs.
FileURI

The primary File (or Directory) URI in the vfs* transport format, for this service.

 


Required

transport.vfs.
ContentType

The expected content type for files retrieved for this service. The VFS
transport uses this information to select the appropriate message builder.
Examples:

  • text/xml for plain XML or SOAP
  • text/plain; charset=ISO-8859-1 for text files
  • application/octet-stream for binary data

 


Optional

transport.vfs.
FileNamePattern

A file name regex pattern to match files against a directory specified
by the FileURI.

 


Optional

transport.
PollInterval

The poll interval (in seconds).

 


Optional

transport.vfs.
ActionAfterProcess

DELETE or MOVE.

 


Optional

transport.vfs.
MoveAfterProcess

The directory to move files after processing (i.e. all files process
successfully).

 


Optional

transport.vfs.
ActionAfterErrors

DELETE or MOVE.

 


Optional

transport.vfs.
MoveAfterErrors

The directory to move files after errors (i.e. some of the files
succeed but some fail).

 


Optional

transport.vfs.
ActionAfterFailure

DELETE or MOVE.

 


Optional

transport.vfs.
MoveAfterFailure

The directory to move after failure (i.e. all files fail).

 


Optional

transport.vfs.
ReplyFileURI

Reply file URI.

 


Optional

transport.vfs.
ReplyFileName

Reply file name (defaults to response XML).

 


Optional

transport.vfs.
MoveTimestampFormat

Timestamp prefix format for processed file name.
java.text.SimpleDateFormat compatible string. e.g. yyMMddHHmmss'-'.

Excerpt
hiddentrue

The description of Proxy Services in the WSO2 ESB.