WLDFRESTNotificationBean (Java API Reference for Oracle WebLogic Server)

Class

Use

Tree

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.diagnostics.descriptor
Interface WLDFRESTNotificationBean

All Superinterfaces:: WLDFBean, WLDFNotificationBean

public interface WLDFRESTNotificationBean

extends WLDFNotificationBean

Use this interface to define a REST action, which is sent when a diagnostic policy evaluates to true.

Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.

Field Summary
`static String`	`BASIC_HTTP_AUTH`
`static String`	`NO_HTTP_AUTH`
`static String`	`REST_POST_METHOD`
`static String`	`REST_PUT_METHOD`

Method Summary
`abstract String`	`getAcceptedResponseType()` Configures the Accept header of the HTTP request to the REST end point.
`abstract Properties`	`getCustomNotificationProperties()` Allows customizing the JSON object delivered to the REST end point.
`abstract String`	`getEndpointURL()` The REST end point URL which will be invoked with the action payload.
`abstract String`	`getHttpAuthenticationMode()` The HTTP authentication mode when invoking the REST end point URL.
`abstract String`	`getHttpAuthenticationPassword()` The HTTP authentication password when the REST end point is secured.
`abstract byte[]`	`getHttpAuthenticationPasswordEncrypted()` The encrypted HTTP authentication password when the REST end point is secured.
`abstract String`	`getHttpAuthenticationUserName()` The HTTP authentication user name when the REST end point is secured.
`abstract String`	`getRestInvocationMethodType()` The REST method for invoking the end point.
`abstract void`	`setAcceptedResponseType(String mimeType)` Configures the Accept header of the HTTP request to the REST end point.
`abstract void`	`setEndpointURL(String restEndpointUrl)` Set REST end point url which will be invoked with the action payload
`abstract void`	`setHttpAuthenticationMode(String httpAuthenticationMode)` Set HTTP authentication mode
`abstract void`	`setHttpAuthenticationPassword(String password)` Set HTTP authentication password for authentication
`abstract void`	`setHttpAuthenticationPasswordEncrypted(byte[] password)` Set encrypted HTTP authentication password
`abstract void`	`setHttpAuthenticationUserName(String userName)` Set the HTTP authentication user name when the REST end point is secured.
`abstract void`	`setRestInvocationMethodType(String restMethod)` Set REST method for invoking end point

Methods inherited from interface weblogic.diagnostics.descriptor.WLDFNotificationBean
`getTimeout, isEnabled, setEnabled, setTimeout`

Methods inherited from interface weblogic.diagnostics.descriptor.WLDFBean
`getId, getName`

Field Detail

NO_HTTP_AUTH

static final String NO_HTTP_AUTH

See Also:: Constant Field Values

BASIC_HTTP_AUTH

static final String BASIC_HTTP_AUTH

See Also:: Constant Field Values

REST_PUT_METHOD

static final String REST_PUT_METHOD

See Also:: Constant Field Values

REST_POST_METHOD

static final String REST_POST_METHOD

See Also:: Constant Field Values

Method Detail

getEndpointURL

String getEndpointURL()

The REST end point URL which will be invoked with the action payload.

setEndpointURL

void setEndpointURL(String restEndpointUrl)

Set REST end point url which will be invoked with the action payload

Parameters:: restEndpointUrl - REST end point url

getRestInvocationMethodType

String getRestInvocationMethodType()

The REST method for invoking the end point.

setRestInvocationMethodType

void setRestInvocationMethodType(String restMethod)

Set REST method for invoking end point

Parameters:: restMethod - REST method

getAcceptedResponseType

String getAcceptedResponseType()

Configures the Accept header of the HTTP request to the REST end point. The response entity of the REST invocation is ignored by the server.

setAcceptedResponseType

void setAcceptedResponseType(String mimeType)

Configures the Accept header of the HTTP request to the REST end point. The response entity of the REST invocation is ignored by the server.

Parameters:: mimeType -

getHttpAuthenticationMode

String getHttpAuthenticationMode()

The HTTP authentication mode when invoking the REST end point URL.

Returns:

setHttpAuthenticationMode

void setHttpAuthenticationMode(String httpAuthenticationMode)

Set HTTP authentication mode

Parameters:: httpAuthenticationMode - Authentication mode to be used.

getHttpAuthenticationUserName

String getHttpAuthenticationUserName()

The HTTP authentication user name when the REST end point is secured.

Returns:

setHttpAuthenticationUserName

void setHttpAuthenticationUserName(String userName)

Set the HTTP authentication user name when the REST end point is secured.

Parameters:: userName - User name for authentication

getHttpAuthenticationPassword

String getHttpAuthenticationPassword()

The HTTP authentication password when the REST end point is secured.

setHttpAuthenticationPassword

void setHttpAuthenticationPassword(String password)

Set HTTP authentication password for authentication

Parameters:: password -

getHttpAuthenticationPasswordEncrypted

byte[] getHttpAuthenticationPasswordEncrypted()

The encrypted HTTP authentication password when the REST end point is secured.

setHttpAuthenticationPasswordEncrypted

void setHttpAuthenticationPasswordEncrypted(byte[] password)

Set encrypted HTTP authentication password

Parameters:: password - Encrypted password

getCustomNotificationProperties

Properties getCustomNotificationProperties()

Allows customizing the JSON object delivered to the REST end point.

Overview

Package