Overview

This resource allows you to manage a SAF Error Handler in a JMS Module of a WebLogic domain.

Here is an example on how you should use this:

wls_saf_error_handler { 'jmsClusterModule:ErrorHandling-0':
  ensure => 'present',
  policy => 'Discard',
}

In this example you are managing a SAF error handler in the default domain. When you want to manage a SAF error handler in a specific domain, you can use:

wls_saf_error_handler { 'my_domain/jmsClusterModule:ErrorHandling-1':
  ensure    => 'present',
  logformat => '%header%%properties%',
  policy    => 'Log',
}

Attributes

Attribute Name Short Description
domain With this parameter, you identify the domain, where your objects is in.
ensure The basic property that the resource should be in.
error_handler_name SAF error handler name
   
jmsmodule The JMS module name.
log_format Specifies how information is logged when Policy is set to Log.
logformat logformat of the SAF imported destination
   
name The name.
notes Optional information that you can include to describe this named JMS descriptor bean.
policy policy of the SAF imported destination
   
provider resource.
saf_error_destination Specifies the error destination when Policy is set to Redirect.
timeout Timeout for applying a resource.

domain

With this parameter, you identify the domain, where your objects is in.

The domain name is part of the full qualified name of any WebLogic object on a system. Let’s say we want to describe a WebLogic server. The full qualified name is:

wls_server{'domain_name/server_name':
  ensure => present,
  ...
}

When you don’t specify a domain name, Puppet will use default as domain name. For every domain you want to manage, you’ll have to put a wls_settings in your manifest.

Back to overview of wls_saf_error_handler

ensure

The basic property that the resource should be in.

Valid values are present, absent. Back to overview of wls_saf_error_handler

error_handler_name

SAF error handler name

Back to overview of wls_saf_error_handler

jmsmodule

The JMS module name.

Back to overview of wls_saf_error_handler

log_format

Specifies how information is logged when Policy is set to Log. Any change to this parameter affects only incoming messages; stored messages are not affected.

An example on how to use this:

wls_saf_error_handler {a_wls_saf_error_handler :
   ...
   log_format => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_saf_error_handler:log_format']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_saf_error_handler

logformat

logformat of the SAF imported destination

Back to overview of wls_saf_error_handler

name

The name.

Back to overview of wls_saf_error_handler

notes

Optional information that you can include to describe this named JMS descriptor bean. JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved. <dl> <dt>Note:</dt> <dd> If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds. </dd> </dl>

An example on how to use this:

wls_saf_error_handler {a_wls_saf_error_handler :
   ...
   notes => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_saf_error_handler:notes']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_saf_error_handler

policy

policy of the SAF imported destination

Valid values are absent, Discard, Log, Redirect, Always-Forward. Back to overview of wls_saf_error_handler

provider

The specific backend to use for this wls_saf_error_handler resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.Available providers are:

simple
saf error handler in a JMS module of an WebLogic domain via regular WLST

Back to overview of wls_saf_error_handler

saf_error_destination

Specifies the error destination when Policy is set to Redirect. Any change to this parameter affects only incoming messages; stored messages are not affected.

An example on how to use this:

wls_saf_error_handler {a_wls_saf_error_handler :
   ...
   saf_error_destination => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_saf_error_handler:saf_error_destination']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_saf_error_handler

timeout

Timeout for applying a resource.

To be sure no Puppet operation, hangs a Puppet daemon, all operations have a timeout. When this timeout expires, Puppet will abort the current operation and signal an error in the Puppet run.

With this parameter, you can specify the length of the timeout. The value is specified in seconds. In this example, the timeout is set to 600 seconds.

wls_server{'my_server':
  ...
  timeout => 600,
}

The default value for timeout is 120 seconds.

Back to overview of wls_saf_error_handler