Class JndiService

Hierarchy

  • JndiService

Constructors

constructor

Methods

createMsgVpnJndiConnectionFactory createMsgVpnJndiQueue createMsgVpnJndiTopic deleteMsgVpnJndiConnectionFactory deleteMsgVpnJndiQueue deleteMsgVpnJndiTopic getMsgVpnJndiConnectionFactories getMsgVpnJndiConnectionFactory getMsgVpnJndiQueue getMsgVpnJndiQueues getMsgVpnJndiTopic getMsgVpnJndiTopics replaceMsgVpnJndiConnectionFactory replaceMsgVpnJndiQueue replaceMsgVpnJndiTopic updateMsgVpnJndiConnectionFactory updateMsgVpnJndiQueue updateMsgVpnJndiTopic

Constructors

constructor

Methods

Static createMsgVpnJndiConnectionFactory

  • Create a JNDI Connection Factory object. Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    connectionFactoryName x x
    msgVpnName x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiConnectionFactoryResponse The JNDI Connection Factory object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnJndiConnectionFactory;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnJndiConnectionFactory

        The JNDI Connection Factory object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiConnectionFactoryResponse | SempMetaOnlyResponse>

Static createMsgVpnJndiQueue

  • Create a JNDI Queue object. Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    msgVpnName x x
    queueName x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiQueueResponse The JNDI Queue object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnJndiQueue;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnJndiQueue

        The JNDI Queue object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiQueueResponse | SempMetaOnlyResponse>

Static createMsgVpnJndiTopic

  • Create a JNDI Topic object. Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    msgVpnName x x
    topicName x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiTopicResponse The JNDI Topic object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnJndiTopic;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnJndiTopic

        The JNDI Topic object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiTopicResponse | SempMetaOnlyResponse>

Static deleteMsgVpnJndiConnectionFactory

  • Delete a JNDI Connection Factory object. Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          connectionFactoryName: string;
          msgVpnName: string;
          xContextId?: string;
      }
      • connectionFactoryName: string

        The name of the JMS Connection Factory. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnJndiQueue

  • Delete a JNDI Queue object. Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          queueName: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • queueName: string

        The JNDI name of the JMS Queue. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static deleteMsgVpnJndiTopic

  • Delete a JNDI Topic object. Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          topicName: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • topicName: string

        The JNDI name of the JMS Topic. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getMsgVpnJndiConnectionFactories

  • Get a list of JNDI Connection Factory objects. Get a list of JNDI Connection Factory objects.

    The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.

    Attribute Identifying Write-Only Deprecated Opaque
    connectionFactoryName x
    msgVpnName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiConnectionFactoriesResponse The list of JNDI Connection Factory objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiConnectionFactoriesResponse | SempMetaOnlyResponse>

Static getMsgVpnJndiConnectionFactory

  • Get a JNDI Connection Factory object. Get a JNDI Connection Factory object.

    The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.

    Attribute Identifying Write-Only Deprecated Opaque
    connectionFactoryName x
    msgVpnName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiConnectionFactoryResponse The JNDI Connection Factory object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          connectionFactoryName: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • connectionFactoryName: string

        The name of the JMS Connection Factory. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiConnectionFactoryResponse | SempMetaOnlyResponse>

Static getMsgVpnJndiQueue

  • Get a JNDI Queue object. Get a JNDI Queue object.

    The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    queueName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiQueueResponse The JNDI Queue object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          opaquePassword?: string;
          queueName: string;
          select?: string[];
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • queueName: string

        The JNDI name of the JMS Queue. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiQueueResponse | SempMetaOnlyResponse>

Static getMsgVpnJndiQueues

  • Get a list of JNDI Queue objects. Get a list of JNDI Queue objects.

    The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    queueName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiQueuesResponse The list of JNDI Queue objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiQueuesResponse | SempMetaOnlyResponse>

Static getMsgVpnJndiTopic

  • Get a JNDI Topic object. Get a JNDI Topic object.

    The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    topicName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiTopicResponse The JNDI Topic object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          topicName: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • topicName: string

        The JNDI name of the JMS Topic. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiTopicResponse | SempMetaOnlyResponse>

Static getMsgVpnJndiTopics

  • Get a list of JNDI Topic objects. Get a list of JNDI Topic objects.

    The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    topicName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiTopicsResponse The list of JNDI Topic objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiTopicsResponse | SempMetaOnlyResponse>

Static replaceMsgVpnJndiConnectionFactory

  • Replace a JNDI Connection Factory object. Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.

    The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    connectionFactoryName x x
    msgVpnName x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiConnectionFactoryResponse The JNDI Connection Factory object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnJndiConnectionFactory;
          connectionFactoryName: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnJndiConnectionFactory

        The JNDI Connection Factory object's attributes. *

      • connectionFactoryName: string

        The name of the JMS Connection Factory. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiConnectionFactoryResponse | SempMetaOnlyResponse>

Static replaceMsgVpnJndiQueue

  • Replace a JNDI Queue object. Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.

    The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    queueName x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiQueueResponse The JNDI Queue object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnJndiQueue;
          msgVpnName: string;
          opaquePassword?: string;
          queueName: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnJndiQueue

        The JNDI Queue object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • queueName: string

        The JNDI name of the JMS Queue. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiQueueResponse | SempMetaOnlyResponse>

Static replaceMsgVpnJndiTopic

  • Replace a JNDI Topic object. Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.

    The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    topicName x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiTopicResponse The JNDI Topic object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnJndiTopic;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          topicName: string;
          xContextId?: string;
      }
      • body: MsgVpnJndiTopic

        The JNDI Topic object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • topicName: string

        The JNDI name of the JMS Topic. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiTopicResponse | SempMetaOnlyResponse>

Static updateMsgVpnJndiConnectionFactory

  • Update a JNDI Connection Factory object. Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged.

    The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    connectionFactoryName x x
    msgVpnName x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiConnectionFactoryResponse The JNDI Connection Factory object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnJndiConnectionFactory;
          connectionFactoryName: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnJndiConnectionFactory

        The JNDI Connection Factory object's attributes. *

      • connectionFactoryName: string

        The name of the JMS Connection Factory. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiConnectionFactoryResponse | SempMetaOnlyResponse>

Static updateMsgVpnJndiQueue

  • Update a JNDI Queue object. Update a JNDI Queue object. Any attribute missing from the request will be left unchanged.

    The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    queueName x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiQueueResponse The JNDI Queue object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnJndiQueue;
          msgVpnName: string;
          opaquePassword?: string;
          queueName: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnJndiQueue

        The JNDI Queue object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • queueName: string

        The JNDI name of the JMS Queue. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiQueueResponse | SempMetaOnlyResponse>

Static updateMsgVpnJndiTopic

  • Update a JNDI Topic object. Update a JNDI Topic object. Any attribute missing from the request will be left unchanged.

    The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    topicName x x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.2.

    Returns

    MsgVpnJndiTopicResponse The JNDI Topic object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnJndiTopic;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          topicName: string;
          xContextId?: string;
      }
      • body: MsgVpnJndiTopic

        The JNDI Topic object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • topicName: string

        The JNDI name of the JMS Topic. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnJndiTopicResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme