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

Access limited to the following security roles:

Deployer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BASIC_HTTP_AUTH
static java.lang.String	NO_HTTP_AUTH
static java.lang.String	REST_POST_METHOD
static java.lang.String	REST_PUT_METHOD

Method Summary

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

Methods inherited from interface weblogic.diagnostics.descriptor.WLDFBean

getId, getName

Methods inherited from interface weblogic.diagnostics.descriptor.WLDFNotificationBean

getTimeout, isEnabled, setEnabled, setTimeout

Field Detail

NO_HTTP_AUTH

static final java.lang.String NO_HTTP_AUTH

See Also:

Constant Field Values

BASIC_HTTP_AUTH

static final java.lang.String BASIC_HTTP_AUTH

See Also:

Constant Field Values

REST_PUT_METHOD

static final java.lang.String REST_PUT_METHOD

See Also:

Constant Field Values

REST_POST_METHOD

static final java.lang.String REST_POST_METHOD

See Also:

Constant Field Values

Method Detail

getEndpointURL

java.lang.String getEndpointURL()

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setEndpointURL

void setEndpointURL(java.lang.String restEndpointUrl)

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

Parameters:

restEndpointUrl - REST end point url

getRestInvocationMethodType

java.lang.String getRestInvocationMethodType()

The REST method for invoking the end point.

Default Value:

weblogic.diagnostics.descriptor.WLDFRESTNotificationBean.REST_PUT_METHOD

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

weblogic.diagnostics.descriptor.WLDFRESTNotificationBean.REST_PUT_METHOD, weblogic.diagnostics.descriptor.WLDFRESTNotificationBean.REST_POST_METHOD

setRestInvocationMethodType

void setRestInvocationMethodType(java.lang.String restMethod)

Set REST method for invoking end point

Parameters:

restMethod - REST method

getAcceptedResponseType

java.lang.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.

Default Value:

javax.ws.rs.core.MediaType.APPLICATION_JSON

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

javax.ws.rs.core.MediaType.APPLICATION_JSON,javax.ws.rs.core.MediaType.TEXT_PLAIN,javax.ws.rs.core.MediaType.TEXT_XML,javax.ws.rs.core.MediaType.TEXT_HTML

setAcceptedResponseType

void setAcceptedResponseType(java.lang.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

java.lang.String getHttpAuthenticationMode()

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

Returns:

Default Value:

weblogic.diagnostics.descriptor.WLDFRESTNotificationBean.NO_HTTP_AUTH

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

weblogic.diagnostics.descriptor.WLDFRESTNotificationBean.NO_HTTP_AUTH, weblogic.diagnostics.descriptor.WLDFRESTNotificationBean.BASIC_HTTP_AUTH

setHttpAuthenticationMode

void setHttpAuthenticationMode(java.lang.String httpAuthenticationMode)

Set HTTP authentication mode

Parameters:

httpAuthenticationMode - Authentication mode to be used.

getHttpAuthenticationUserName

java.lang.String getHttpAuthenticationUserName()

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

Returns:

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setHttpAuthenticationUserName

void setHttpAuthenticationUserName(java.lang.String userName)

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

Parameters:

userName - User name for authentication

getHttpAuthenticationPassword

java.lang.String getHttpAuthenticationPassword()

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

setHttpAuthenticationPassword

void setHttpAuthenticationPassword(java.lang.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.

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setHttpAuthenticationPasswordEncrypted

void setHttpAuthenticationPasswordEncrypted(byte[] password)

Set encrypted HTTP authentication password

Parameters:

password - Encrypted password

getCustomNotificationProperties

java.util.Properties getCustomNotificationProperties()

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.