Jump to

• Request
• Response

View This JMS Bridge Destination Collection

get

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSBridgeDestinations

View this JMS bridge destination collection.

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 a list of JMS bridge destination entities.

This method can return the following links:

• rel=create-form uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSBridgeDestinationCreateForm

  The create form resource for this collection resource.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object JMS Bridge Destination

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/JMS Bridge Destination"
    },
    "description":""
}

Nested Schema : JMS Bridge Destination

Type: object

Show Source

• adapterJNDIName(optional): string
  Default Value: eis.jms.WLSConnectionFactoryJNDIXA

  The JNDI name of the adapter used to communicate with the specified destination.

  This name is specified in the adapter's deployment descriptor file and is used by the WebLogic Server Connector container to bind the adapter in WebLogic Server JNDI.

  Constraints

  • legal null
  • not visible for domain scoped mbeans
• connectionFactoryJNDIName(optional): string

  The connection factory's JNDI name for this JMS bridge destination.

  Constraints

  • not visible for domain scoped mbeans
• connectionURL(optional): string

  The connection URL for this JMS bridge destination.

  Constraints

  • not visible for domain scoped mbeans
• destinationJNDIName(optional): string

  The destination JNDI name for this JMS bridge destination.

  Constraints

  • not visible for domain scoped mbeans
• destinationType(optional): string
  Default Value: Queue

  Allowed Values: [ "Queue", "Topic" ]

  The destination type (queue or topic) for this JMS bridge destination.

  Constraints

  • not visible for domain scoped mbeans
• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

  Constraints

  • not visible for domain scoped mbeans
• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

  Constraints

  • not visible for domain scoped mbeans
• initialContextFactory(optional): string
  Default Value: weblogic.jndi.WLInitialContextFactory

  The initial context factory name for this JMS bridge destination.

  Constraints

  • not visible for domain scoped mbeans
• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) 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.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

  Constraints

  • not visible for domain scoped mbeans
• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• userName(optional): string

  The optional user name the adapter uses to access the bridge destination.

  All operations on the specified destination are done using this user name and the corresponding password. Therefore, the User Name/Password for the source and target destinations must have permission to the access the underlying destinations in order for the messaging bridge to work.

  Constraints

  • not visible for domain scoped mbeans
• userPassword(optional): string(password)

  The user password that the adapter uses to access the bridge destination.

  As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:

  1. Retrieves the value of the UserPasswordEncrypted attribute.

  2. Decrypts the value and returns the unencrypted password as a String.

  When you set the value of this attribute, WebLogic Server does the following:

  1. Encrypts the value.

  2. Sets the value of the UserPasswordEncrypted attribute to the encrypted value.

  Using this attribute (UserPassword) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.

  Instead of using this attribute, use UserPasswordEncrypted

  Constraints

  • not visible for domain scoped mbeans

{
    "type":"object",
    "properties":{
        "adapterJNDIName":{
            "default":"eis.jms.WLSConnectionFactoryJNDIXA",
            "x-weblogic-legalNull":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The JNDI name of the adapter used to communicate with the specified destination.</p><p>This name is specified in the adapter's deployment descriptor file and is used by the WebLogic Server Connector container to bind the adapter in WebLogic Server JNDI.</p><p><h5>Constraints</h5></p><ul><li>legal null</li><li>not visible for domain scoped mbeans</li></ul>"
        },
        "connectionFactoryJNDIName":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The connection factory's JNDI name for this JMS bridge destination.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "connectionURL":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The connection URL for this JMS bridge destination.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "destinationJNDIName":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The destination JNDI name for this JMS bridge destination.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "destinationType":{
            "default":"Queue",
            "enum":[
                "Queue",
                "Topic"
            ],
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The destination type (queue or topic) for this JMS bridge destination.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "id":{
            "readOnly":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "initialContextFactory":{
            "default":"weblogic.jndi.WLInitialContextFactory",
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The initial context factory name for this JMS bridge destination.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><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 configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "tags":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "userName":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The optional user name the adapter uses to access the bridge destination.</p><p>All operations on the specified destination are done using this user name and the corresponding password. Therefore, the User Name/Password for the source and target destinations must have permission to the access the underlying destinations in order for the messaging bridge to work.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "userPassword":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "format":"password",
            "description":"<p>The user password that the adapter uses to access the bridge destination.</p><p>As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:</p><ol><li><p>Retrieves the value of the <code>UserPasswordEncrypted</code> attribute.</p></li><li><p>Decrypts the value and returns the unencrypted password as a String.</p></li></ol><p>When you set the value of this attribute, WebLogic Server does the following:</p><ol><li><p>Encrypts the value.</p></li><li><p>Sets the value of the <code>UserPasswordEncrypted</code> attribute to the encrypted value.</p></li></ol><p>Using this attribute (<code>UserPassword</code>) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.</p><p>Instead of using this attribute, use <code>UserPasswordEncrypted</code></p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Constraints

• not visible for domain scoped mbeans

Show Source

• Array of: string

{
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}

Back to Top