Jump to

• Request
• Response

GET A Create Form For This Interceptor Collection

get

/management/weblogic/{version}/edit/interceptors/interceptorCreateForm

This resource returns a pre-populated interceptor model that can be customized then posted (using the POST method) to the interceptors collection resource to create a new interceptor.

Request

Path Parameters

• 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 interceptor.

This method can return the following links:

• rel=create uri=/management/weblogic/{version}/edit/interceptors/interceptors

  The collection resource for this create form resource.

Body ()

Root Schema : Interceptor

Type: object

Show Source

• dependsOn(optional): array Items
  Title: Items

  The set of interceptor names this interceptor depends on. The specified interceptors will appear before this interceptor in the invocation chain.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

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

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

  Return the unique id of this MBean instance

• interceptedOperationNames(optional): array Items
  Title: Items

  The name of the operation / method that needs to intercepted by this interceptor's method. If the return value is null or "*" then all operations are intercepted by this interceptor.

• interceptedTargetKey(optional): string

  The key associated with the intercepted target. This is the value that would have been specified in the @InterceptedTargetKey annotation. If this is null then this Interceptor is ignored.

• interceptorTypeName(optional): string

  The HK2 name of the interceptor class.

• 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.

• priority(optional): integer(int32)
  Default Value: 1073741823

  The priority of this intercepted method in the interceptor chain. An interceptor with a higher priority will be executed earlier than an interceptor with a lower priority.

  Note: 1073741823 is actually Integer.MAX_VALUE / 2 as defined in InterceptorPriorities.

• properties(optional): object Properties
  Title: Properties

  Additional Properties Allowed: additionalProperties

  A set of pairs that needs to be passed to the interceptor.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "dependsOn":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The set of interceptor names this interceptor depends on. The specified interceptors will appear before this interceptor in the invocation chain.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "interceptedOperationNames":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The name of the operation / method that needs to intercepted by this interceptor's method. If the return value is null or \"*\" then all operations are intercepted by this interceptor.</p>"
        },
        "interceptedTargetKey":{
            "type":"string",
            "description":"<p>The key associated with the intercepted target. This is the value that would have been specified in the @InterceptedTargetKey annotation. If this is null then this Interceptor is ignored.</p>"
        },
        "interceptorTypeName":{
            "type":"string",
            "description":"<p>The HK2 name of the interceptor class.</p>"
        },
        "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>"
        },
        "priority":{
            "default":1073741823,
            "type":"integer",
            "format":"int32",
            "description":"<p>The priority of this intercepted method in the interceptor chain. An interceptor with a higher priority will be executed earlier than an interceptor with a lower priority.</p><p>Note:  1073741823 is actually Integer.MAX_VALUE / 2 as defined in InterceptorPriorities.</p>"
        },
        "properties":{
            "type":"object",
            "description":"<p> A set of <name, value> pairs that needs to be passed to the interceptor.</p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "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>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

The set of interceptor names this interceptor depends on. The specified interceptors will appear before this interceptor in the invocation chain.

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The set of interceptor names this interceptor depends on. The specified interceptors will appear before this interceptor in the invocation chain.</p>"
}

Nested Schema : Items

Type: array

Title: Items

The name of the operation / method that needs to intercepted by this interceptor's method. If the return value is null or "*" then all operations are intercepted by this interceptor.

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The name of the operation / method that needs to intercepted by this interceptor's method. If the return value is null or \"*\" then all operations are intercepted by this interceptor.</p>"
}

Nested Schema : Properties

Type: object

Title: Properties

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"<p> A set of <name, value> pairs that needs to be passed to the interceptor.</p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

A set of pairs that needs to be passed to the interceptor.

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Back to Top