Oracle Communications Services Gatekeeper OAM Java API Reference
7.0.0.1

E96580-01

com.bea.wlcp.wlng.httpproxy.management
Interface HTTPProxyMBean


public interface HTTPProxyMBean

Plugin http proxy service MBean interface.


Field Summary
static boolean httpBasicAuthentication
          Enables HTTP BASIC Authentication.
static java.lang.String networkEndPoint
          Sets Network Endpoint for MT requests
static java.lang.String password
          Password for authentication
static java.lang.String userName
          Username for authentication
static boolean userNameTokenAuthentication
          Enables WS-Security with usernametoken
 
Method Summary
abstract  void addApplicationEndPoint(java.lang.String appinstanceId, java.lang.String callbackUrl)
          Adds application end point.
abstract  java.lang.String getApplicationEndPoint(java.lang.String appinstanceId)
          Gets Application Endpoint for appinstanceId.
abstract  boolean getHttpBasicAuthentication()
           
abstract  int getHttpTimeoutPeriod()
          Gets the time (seconds) window/period in which x number of timeouts are allowed before plug-in instance is disconnected.
abstract  int getHttpTimeoutThreshold()
          Gets the number of HTTP timeouts that are allowed in a http timeout period before plug-in instance is disconnected.
abstract  int getHttpWaitTime()
          Gets HTTP wait time (Request-time->Response) in seconds for MT requests.
abstract  java.lang.String getNetworkEndpoint()
           
abstract  java.lang.String getPassword()
           
abstract  int getReactivateTime()
          Gets the time (seconds) a plug-in instance should stay disconnected after having been disconnected due to http timeout criteria.
abstract  java.lang.String getUserName()
           
abstract  boolean getUserNameTokenAuthentication()
           
abstract  java.lang.String[] listApplicationEndPoints()
          List all the application end points.
abstract  void removeApplicationEndPoint(java.lang.String appinstanceId)
          Updates Application Endpoint for applicationId
abstract  void setHttpBasicAuthentication(boolean value)
           
abstract  void setHttpTimeoutPeriod(int value)
          Sets the time (seconds) window/period in wich x number of timeouts are allowed before plug-in instance is disconnected.
abstract  void setHttpTimeoutThreshold(int value)
          Sets the number of HTTP timeouts that are allowed in a http timeout period before plug-in instance is disconnected.
abstract  void setHttpWaitTime(int value)
          Sets HTTP wait time (Request-time->Response) in seconds for MT requests.
abstract  void setNetworkEndpoint(java.lang.String value)
           
abstract  void setPassword(java.lang.String value)
           
abstract  void setReactivateTime(int value)
          Sets the time (seconds) a plug-in instance should stay disconnected after having been disconnected due to http timeout criteria.
abstract  void setUserName(java.lang.String value)
           
abstract  void setUserNameTokenAuthentication(boolean value)
           
 

Field Detail

httpBasicAuthentication

public static final boolean httpBasicAuthentication
Enables HTTP BASIC Authentication.

Scope: Cluster

See Also:
Constant Field Values

networkEndPoint

public static final java.lang.String networkEndPoint
Sets Network Endpoint for MT requests

Scope: Cluster

See Also:
Constant Field Values

password

public static final java.lang.String password
Password for authentication

Scope: Cluster

See Also:
Constant Field Values

userName

public static final java.lang.String userName
Username for authentication

Scope: Cluster

See Also:
Constant Field Values

userNameTokenAuthentication

public static final boolean userNameTokenAuthentication
Enables WS-Security with usernametoken

Scope: Cluster

See Also:
Constant Field Values
Method Detail

addApplicationEndPoint

public void addApplicationEndPoint(java.lang.String appinstanceId,
                                   java.lang.String callbackUrl)
                            throws com.bea.wlcp.wlng.api.management.ManagementException
Adds application end point.

Scope: Cluster

Parameters:
appinstanceId - Application Instance.
callbackUrl - Callback URL.
Throws:
ManagementException.
com.bea.wlcp.wlng.api.management.ManagementException

getApplicationEndPoint

public java.lang.String getApplicationEndPoint(java.lang.String appinstanceId)
                                        throws com.bea.wlcp.wlng.api.management.ManagementException
Gets Application Endpoint for appinstanceId.

Scope: Cluster

Parameters:
appinstanceId - application instance id.
Returns:
Application Endpoint for appinstanceId.
Throws:
ManagementException.
com.bea.wlcp.wlng.api.management.ManagementException

getHttpBasicAuthentication

public boolean getHttpBasicAuthentication()
                                   throws com.bea.wlcp.wlng.api.management.ManagementException
Throws:
com.bea.wlcp.wlng.api.management.ManagementException

getHttpTimeoutPeriod

public int getHttpTimeoutPeriod()
                         throws com.bea.wlcp.wlng.api.management.ManagementException
Gets the time (seconds) window/period in which x number of timeouts are allowed before plug-in instance is disconnected. Requests outside the window/time period are not taken into consideration when deciding if plug-in instance should be disconnected or not. Value is effective for all new events.

Scope: Cluster

Throws:
com.bea.wlcp.wlng.api.management.ManagementException

getHttpTimeoutThreshold

public int getHttpTimeoutThreshold()
                            throws com.bea.wlcp.wlng.api.management.ManagementException
Gets the number of HTTP timeouts that are allowed in a http timeout period before plug-in instance is disconnected. Value is effective for all new events.

Scope: Cluster

Throws:
com.bea.wlcp.wlng.api.management.ManagementException

getHttpWaitTime

public int getHttpWaitTime()
                    throws com.bea.wlcp.wlng.api.management.ManagementException
Gets HTTP wait time (Request-time->Response) in seconds for MT requests. Value is effective for all new events.

Scope: Cluster

Throws:
com.bea.wlcp.wlng.api.management.ManagementException

getNetworkEndpoint

public java.lang.String getNetworkEndpoint()
                                    throws com.bea.wlcp.wlng.api.management.ManagementException
Throws:
com.bea.wlcp.wlng.api.management.ManagementException

getPassword

public java.lang.String getPassword()
                             throws com.bea.wlcp.wlng.api.management.ManagementException
Throws:
com.bea.wlcp.wlng.api.management.ManagementException

getReactivateTime

public int getReactivateTime()
                      throws com.bea.wlcp.wlng.api.management.ManagementException
Gets the time (seconds) a plug-in instance should stay disconnected after having been disconnected due to http timeout criteria. If 0 or negative value is used the plug-in instance is not connected automatically. If the number of time-outs are exceeded, the plug-in instance transfers to state disconnected, which means that it does not accept new requests. It stays disconnected during the time-period defined in ReactivateTime. Value is effective for all new events.

Scope: Cluster

Throws:
com.bea.wlcp.wlng.api.management.ManagementException

getUserName

public java.lang.String getUserName()
                             throws com.bea.wlcp.wlng.api.management.ManagementException
Throws:
com.bea.wlcp.wlng.api.management.ManagementException

getUserNameTokenAuthentication

public boolean getUserNameTokenAuthentication()
                                       throws com.bea.wlcp.wlng.api.management.ManagementException
Throws:
com.bea.wlcp.wlng.api.management.ManagementException

listApplicationEndPoints

public java.lang.String[] listApplicationEndPoints()
                                            throws com.bea.wlcp.wlng.api.management.ManagementException
List all the application end points.

Scope: Cluster

Returns:
end point URL.
Throws:
ManagementException.
com.bea.wlcp.wlng.api.management.ManagementException

removeApplicationEndPoint

public void removeApplicationEndPoint(java.lang.String appinstanceId)
                               throws com.bea.wlcp.wlng.api.management.ManagementException
Updates Application Endpoint for applicationId

Scope: Cluster

Parameters:
appinstanceId - application instance id.
Throws:
ManagementException.
com.bea.wlcp.wlng.api.management.ManagementException

setHttpBasicAuthentication

public void setHttpBasicAuthentication(boolean value)
                                throws com.bea.wlcp.wlng.api.management.ManagementException
Throws:
com.bea.wlcp.wlng.api.management.ManagementException

setHttpTimeoutPeriod

public void setHttpTimeoutPeriod(int value)
                          throws com.bea.wlcp.wlng.api.management.ManagementException
Sets the time (seconds) window/period in wich x number of timeouts are allowed before plug-in instance is disconnected. Requests outside the window/time period are not taken into consideration when deciding if plug-in instance should be disconnected or not. Value is effective for all new events.

Scope: Cluster

Throws:
com.bea.wlcp.wlng.api.management.ManagementException

setHttpTimeoutThreshold

public void setHttpTimeoutThreshold(int value)
                             throws com.bea.wlcp.wlng.api.management.ManagementException
Sets the number of HTTP timeouts that are allowed in a http timeout period before plug-in instance is disconnected. Value is effective for all new events.

Scope: Cluster

Throws:
com.bea.wlcp.wlng.api.management.ManagementException

setHttpWaitTime

public void setHttpWaitTime(int value)
                     throws com.bea.wlcp.wlng.api.management.ManagementException
Sets HTTP wait time (Request-time->Response) in seconds for MT requests. Value is effective for all new events.

Scope: Cluster

Throws:
com.bea.wlcp.wlng.api.management.ManagementException

setNetworkEndpoint

public void setNetworkEndpoint(java.lang.String value)
                        throws com.bea.wlcp.wlng.api.management.ManagementException
Throws:
com.bea.wlcp.wlng.api.management.ManagementException

setPassword

public void setPassword(java.lang.String value)
                 throws com.bea.wlcp.wlng.api.management.ManagementException
Throws:
com.bea.wlcp.wlng.api.management.ManagementException

setReactivateTime

public void setReactivateTime(int value)
                       throws com.bea.wlcp.wlng.api.management.ManagementException
Sets the time (seconds) a plug-in instance should stay disconnected after having been disconnected due to http timeout criteria. If 0 or negative value is used the plug-in instance is not connected automatically. Value is effective for all new events.

Scope: Cluster

Throws:
com.bea.wlcp.wlng.api.management.ManagementException

setUserName

public void setUserName(java.lang.String value)
                 throws com.bea.wlcp.wlng.api.management.ManagementException
Throws:
com.bea.wlcp.wlng.api.management.ManagementException

setUserNameTokenAuthentication

public void setUserNameTokenAuthentication(boolean value)
                                    throws com.bea.wlcp.wlng.api.management.ManagementException
Throws:
com.bea.wlcp.wlng.api.management.ManagementException

Oracle Communications Services Gatekeeper OAM Java API Reference
7.0.0.1

E96580-01

Copyright © 2008, 2018, Oracle and/or its affiliates. All rights reserved.