rvicemix.servicemix-snmp.2010.02.source-code.servicemix-snmp.xsd.wiki Maven / Gradle / Ivy
h3. Elements By Type
{anchor:org.apache.servicemix.snmp.SnmpEndpointType-types}
h4. The _[org.apache.servicemix.snmp.SnmpEndpointType|#org.apache.servicemix.snmp.SnmpEndpointType-types]_ Type Implementations
| _[|#poller-element]_ | {html}This is the polling endpoint for the snmp component.{html} |
| _[|#trap-consumer-element]_ | {html}This is the trap endpoint for the snmp component.
This endpoint receives and process trap PDUs from
a device. Then it sends an exchange to the target service
containing the processed content.{html} |
{anchor:component-element}
h3. The _[|#component-element]_ Element
{html}SNMP Component{html}
h4. Properties
|| Property Name || Type || Description ||
| endpoints | (_[org.apache.servicemix.snmp.SnmpEndpointType|#org.apache.servicemix.snmp.SnmpEndpointType-types]_)\* | {html}{html} |
| executorFactory | _org.apache.servicemix.executors.ExecutorFactory_ | {html}The executor factory to use to create the executor.
If none is provided, one will be retrieved from the JBI container when the component
is deployed into ServiceMix 3.x, or a default implementation will be used.{html} |
{anchor:poller-element}
h3. The _[|#poller-element]_ Element
{html}This is the polling endpoint for the snmp component.{html}
h4. Properties
|| Property Name || Type || Description ||
| address | _java.lang.String_ | {html}Specifies the connection URI used to connect to a snmp capable device.
Template:
<protocol>:<host>/<port>
Details:
Name
Description
protocol
the protocol to use (udp or tcp)
host
the name or ip address of the snmp capable device
port
the port number to use
Example:
udp:192.168.2.122/161
The default value is null
{html} |
| concurrentPolling | _boolean_ | {html}Sets whether more than one poll can be active at a time (true means yes). Default value is false.{html} |
| delay | _long_ | {html}Sets the amount of time in milliseconds that the endpoint should wait before making the first poll.{html} |
| endpoint | _java.lang.String_ | {html}The name of the endpoint.{html} |
| firstTime | _java.util.Date_ | {html}Sets the date on which the first poll will be executed. If a delay is
also set using setDelay, the delay interval will be added
after the date specified.{html} |
| interfaceName | _javax.xml.namespace.QName_ | {html}The qualified name of the interface exposed by the endpoint.{html} |
| marshaler | _org.apache.servicemix.snmp.marshaler.SnmpMarshalerSupport_ | {html}Specifies a marshaler class which provides the logic for converting
a snmp response into a normalized message. This class has to implement
the SnmpMarshalerSupport interface. If you don't specify a
marshaler, the DefaultSnmpMarshaler will be used.
{html} |
| oids | (_java.lang.Object_)\* | {html}Specifies a reference to a list of OID values which will be used for
the snmp request. You have two possibilities how to specify the value:
a) referencing to a file containing a list of OID values separated by a line feed
or
b) defining a coma (,) separated list of OID values
Examples:
a) oids="classpath:myOids.txt"
oids="file:/home/lhein/snmp/device_a/oids.txt"
b) oids="1.3.6.1.2.1.1.3.0 , 1.3.6.1.2.1.25.3.2.1.5.1 , 1.3.6.1.2.1.25.3.5.1.1.1 , 1.3.6.1.2.1.43.5.1.1.11.1"
The default value is null
{html} |
| period | _long_ | {html}Sets the number of milliseconds between polling attempts.{html} |
| retries | _int_ | {html}Specifies the connection retries.
The default value is 2
{html} |
| scheduler | _org.apache.servicemix.common.scheduler.Scheduler_ | {html}Set a custom Scheduler implementation if you need more fine-grained control over the polling schedule.{html} |
| service | _javax.xml.namespace.QName_ | {html}The qualified name of the service the endpoint exposes.{html} |
| snmpCommunity | _java.lang.String_ | {html}Specifies the snmp community to use.
The default value is "public"
{html} |
| snmpVersion | _int_ | {html}Specifies the snmp protocol version to use.
The default value is 0 (version 1)
{html} |
| targetEndpoint | _java.lang.String_ | {html}the name of the endpoint to which requests are sent{html} |
| targetInterface | _javax.xml.namespace.QName_ | {html}the QName of the interface to which requests are sent{html} |
| targetOperation | _javax.xml.namespace.QName_ | {html}the QName of the operation to which requests are sent{html} |
| targetService | _javax.xml.namespace.QName_ | {html}the QName of the service to which requests are sent{html} |
| targetUri | _java.lang.String_ | {html}Set the target service/endpoint/interface using a URI.{html} |
| timeout | _int_ | {html}Specifies the connection time out in milliseconds.
The default value is 1500
{html} |
{anchor:trap-consumer-element}
h3. The _[|#trap-consumer-element]_ Element
{html}This is the trap endpoint for the snmp component.
This endpoint receives and process trap PDUs from
a device. Then it sends an exchange to the target service
containing the processed content.{html}
h4. Properties
|| Property Name || Type || Description ||
| address | _java.lang.String_ | {html}Specifies the connection URI used to connect to a snmp capable device.
Template:
<protocol>:<host>/<port>
Details:
Name
Description
protocol
the protocol to use (udp or tcp)
host
the name or ip address of the snmp capable device
port
the port number to use
Example:
udp:192.168.2.122/162
The default value is null
{html} |
| enabled | _boolean_ | {html}Specifies wether the endpoint is enabled or not.
If its value is set to true, the connection data will be
setted and trap PDUs will be processed. Otherwise,
the endpoint won't do anything.
{html} |
| endpoint | _java.lang.String_ | {html}The name of the endpoint.{html} |
| interfaceName | _javax.xml.namespace.QName_ | {html}The qualified name of the interface exposed by the endpoint.{html} |
| marshaler | _org.apache.servicemix.snmp.marshaler.SnmpMarshalerSupport_ | {html}Specifies a marshaler class which provides the logic for converting
a snmp trap into a normalized message. This class has to implement
the SnmpMarshalerSupport interface. If you don't specify a
marshaler, the DefaultSnmpMarshaler will be used.
{html} |
| service | _javax.xml.namespace.QName_ | {html}The qualified name of the service the endpoint exposes.{html} |
| targetEndpoint | _java.lang.String_ | {html}the name of the endpoint to which requests are sent{html} |
| targetInterface | _javax.xml.namespace.QName_ | {html}the QName of the interface to which requests are sent{html} |
| targetOperation | _javax.xml.namespace.QName_ | {html}the QName of the operation to which requests are sent{html} |
| targetService | _javax.xml.namespace.QName_ | {html}the QName of the service to which requests are sent{html} |
| targetUri | _java.lang.String_ | {html}Set the target service/endpoint/interface using a URI.{html} |
h3. Element Index
| _[|#component-element]_ | {html}SNMP Component{html} |
| _[|#poller-element]_ | {html}This is the polling endpoint for the snmp component.{html} |
| _[|#trap-consumer-element]_ | {html}This is the trap endpoint for the snmp component.
This endpoint receives and process trap PDUs from
a device. Then it sends an exchange to the target service
containing the processed content.{html} |