Jump to

• Request
• Response

View This JMS Connection Factory

get

/management/weblogic/{version}/domainConfig/JMSInteropModules/{name}/JMSResource/connectionFactories/{name}

View this JMS connection factory.

Request

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Query Parameters

• excludeFields(optional): string
  The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
• excludeLinks(optional): string
  The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
• fields(optional): string
  The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
• links(optional): string
  The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this JMS connection factory.

This method can return the following links:

• rel=clientParams uri=/management/weblogic/{version}/domainConfig/JMSInteropModules/{name}/JMSResource/connectionFactories/{name}/clientParams

  This resource's clientParams singleton resource.

• rel=defaultDeliveryParams uri=/management/weblogic/{version}/domainConfig/JMSInteropModules/{name}/JMSResource/connectionFactories/{name}/defaultDeliveryParams

  This resource's defaultDeliveryParams singleton resource.

• rel=flowControlParams uri=/management/weblogic/{version}/domainConfig/JMSInteropModules/{name}/JMSResource/connectionFactories/{name}/flowControlParams

  This resource's flowControlParams singleton resource.

• rel=loadBalancingParams uri=/management/weblogic/{version}/domainConfig/JMSInteropModules/{name}/JMSResource/connectionFactories/{name}/loadBalancingParams

  This resource's loadBalancingParams singleton resource.

• rel=securityParams uri=/management/weblogic/{version}/domainConfig/JMSInteropModules/{name}/JMSResource/connectionFactories/{name}/securityParams

  This resource's securityParams singleton resource.

• rel=transactionParams uri=/management/weblogic/{version}/domainConfig/JMSInteropModules/{name}/JMSResource/connectionFactories/{name}/transactionParams

  This resource's transactionParams singleton resource.

Body ()

Root Schema : JMS Connection Factory

Type: object

Show Source

• defaultTargetingEnabled(optional): boolean
  Default Value: false

  Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.

  When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.

• id(optional): integer(int64)
  Read Only: true

  Return the unique identifier of this bean instance.

• JNDIName(optional): string

  The global JNDI name used to look up a connection factory within a clustered JNDI namespace.

  In a clustered environment, this name is propagated to the entire cluster. If you want the JNDI name to be bound only on the local server, and not propagated to the rest of the cluster, then use the Local JNDI Name setting.

  If not specified, then the connection factory is not bound into a clustered JNDI namespace.

• localJNDIName(optional): string

  The local JNDI name used to look up the connection factory within the JNDI namespace of the server where the connection factory is targeted. In a clustered environment, this name is bound only on the local server instance and is not propagated to the rest of the cluster.

  If not specified, then the connection factory is not bound into the local JNDI namespace.

• name(optional): string
  Read Only: true

  Constraints

  • legal null
• notes(optional): string

  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 <. Carriage returns/line feeds are preserved.

  Note:

  If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• subDeploymentName(optional): string

  Gets the name of the sub-deployment to use when targeting this entity

  Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.

{
    "type":"object",
    "properties":{
        "JNDIName":{
            "type":"string",
            "description":"<p>The global JNDI name used to look up a connection factory within a clustered JNDI namespace.</p><p>In a clustered environment, this name is propagated to the entire cluster. If you want the JNDI name to be bound only on the local server, and not propagated to the rest of the cluster, then use the <code>Local JNDI Name</code> setting.</p><p>If not specified, then the connection factory is not bound into a clustered JNDI namespace.</p>"
        },
        "defaultTargetingEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.</p><p>When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified. </p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique identifier of this bean instance.</p>"
        },
        "localJNDIName":{
            "type":"string",
            "description":"<p>The local JNDI name used to look up the connection factory within the JNDI namespace of the server where the connection factory is targeted. In a clustered environment, this name is bound only on the local server instance and is not propagated to the rest of the cluster.</p><p>If not specified, then the connection factory is not bound into the local JNDI namespace.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this named JMS descriptor bean.</p><p>JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><dl><dt>Note:</dt><dd><p>If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p></dd></dl>"
        },
        "subDeploymentName":{
            "type":"string",
            "description":"<p>Gets the name of the sub-deployment to use when targeting this entity</p><p> Entities are targeted using a sub-deployment with this name.  The targets of the sub-deployment will be the targets of this entity. </p>"
        }
    },
    "description":""
}

Back to Top