Package weblogic.management.runtime

Interface ConsoleRuntimeMBean

All Superinterfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, RuntimeMBean, WebLogicMBean

@Deprecated
public interface ConsoleRuntimeMBean
extends RuntimeMBean

Deprecated.

14.1.2.0.0

Runtime services for the console.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDefaultPageURL(java.lang.String[] context, java.lang.String perspective)	Deprecated. Gets the URL for the default page of an object.
java.lang.String[]	getDefaultPageURLs(java.lang.String[][] contexts, java.lang.String perspective)	Deprecated. Gets the URLs for the default pages for a set of objects.
java.lang.String[]	getDefaultPageURLs(java.lang.String[][] contexts, java.lang.String[] perspectives)	Deprecated. Gets the URLs for the default pages for a set of objects.
java.lang.String	getHomePageURL()	Deprecated. Gets the URL for the console's home page
java.lang.String[]	getObjectNameContext(java.lang.String objectName)	Deprecated. Gets a context for a WLS mbean.
java.lang.String	getSpecificPageURL(java.lang.String page, java.lang.String[] context)	Deprecated. Gets the URL for a specific console page.
java.lang.String[]	getSpecificPageURLs(java.lang.String[] pages, java.lang.String[][] contexts)	Deprecated. Gets the URLs for a set of specific console pages.
java.lang.String[]	getSpecificPageURLs(java.lang.String page, java.lang.String[][] contexts)	Deprecated. Gets the URLs for a set of specific console page.
boolean	isEnabled()	Deprecated. Is the console enabled?

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Method Detail

isEnabled

boolean isEnabled()

Deprecated.

Is the console enabled?

Returns:

true if the console is enabled in this domain

getHomePageURL

java.lang.String getHomePageURL()

Deprecated.

Gets the URL for the console's home page

Returns:

the URL of the console's homepage

getDefaultPageURL

java.lang.String getDefaultPageURL(java.lang.String[] context,
                                   java.lang.String perspective)

Deprecated.

Gets the URL for the default page of an object. You can optionally specify the kind of default page (e.g. configuration or monitoring). For example, use this method to get a WLS cluster's default page's URL. Use this method when possible since it isolates the caller from the specific console page labels. This method does not check whether the page exists. To find out, use the URL and see if it works.

Parameters:

context - Identifies the object the page should display or manage. Most pages display or manage WLS mbeans (such as a server or cluster). For them, call "getObjectNameContext", passing in the JMX object name, to get the context to pass to this method. See the console programmers' guide for more information on contexts.

perspective - Specifies which kind of default page to return (e.g. configuration or monitoring). Pass in null to get the default page for the object. See the console programmers' guide for more information on perspectives.

Returns:

the URL of the corresponding console page

Throws:

java.lang.IllegalArgumentException - if context is null or empty

See Also:

getObjectNameContext(java.lang.String)

All security roles can access this item.

getDefaultPageURLs

java.lang.String[] getDefaultPageURLs(java.lang.String[][] contexts,
                                      java.lang.String perspective)

Deprecated.

Gets the URLs for the default pages for a set of objects. This method works exactly like getDefaultPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Parameters:

contexts - An array of contexts identifying the object each page should display or manage.

perspective - Specifies which kind of default page to return for all of the pages.

Returns:

an array of URLs for the requested pages.

Throws:

java.lang.IllegalArgumentException - if contexts is null, or if there is a problem with the information for any of the pages (e.g. contexts[2] is null or an empty string). The returned array of URLs parallels the contexts array. For example, return[1] contains the result for contexts[1].

See Also:

getDefaultPageURL(java.lang.String[], java.lang.String)

All security roles can access this item.

getDefaultPageURLs

java.lang.String[] getDefaultPageURLs(java.lang.String[][] contexts,
                                      java.lang.String[] perspectives)

Deprecated.

Gets the URLs for the default pages for a set of objects. This method works exactly like getDefaultPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Parameters:

contexts - An array of contexts identifying the object each page should display or manage.

perspectives - An array of perspectives identifying which kind of default page to return for each object.

Returns:

an array of URLs for the requested pages.

Throws:

java.lang.IllegalArgumentException - if contexts or perspectives is null, contexts and perspectives don't have the same length, or if there is a problem with the information for any of the pages (e.g. contexts[2] is null or an empty string). The contexts and perspecitives arrays are parallel arrays specifying each desired page. They must be the same length. For example, contexts[1] and perspectives[1] are used to indicate the information needed to compute the URL for the second page. Similarly, the returned array of URLs parallels the contexts and perspectives arrays. For example, return[1] contains the result for contexts[1]/perspectives[1].

See Also:

getDefaultPageURL(java.lang.String[], java.lang.String)

All security roles can access this item.

getSpecificPageURL

java.lang.String getSpecificPageURL(java.lang.String page,
                                    java.lang.String[] context)

Deprecated.

Gets the URL for a specific console page. For example, use this method to get a WLS server's SSL configuration page's URL or the servers table page's URL. Note: WLS reserves the right to change its portal page names in future releases. Therefore, customers are advised to use "getDefaultPageURL" if possible so that they'll be isolated from these kinds of changes. This method does not check whether the page exists. To find out, use the URL and see if it works.

Parameters:

page - The portal page label of the desired console page.

context - Identifies the object the page should display or manage. Most pages display or manage WLS mbeans (such as a server or cluster). For them, call "getObjectNameContext", passing in the JMX object name, to get the context to pass to this method. See the console programmers' guide for more information on contexts.

Returns:

the URL of the corresponding console page

Throws:

java.lang.IllegalArgumentException - if page is null or empty

See Also:

getDefaultPageURL(java.lang.String[], java.lang.String)

All security roles can access this item.

getSpecificPageURLs

java.lang.String[] getSpecificPageURLs(java.lang.String page,
                                       java.lang.String[][] contexts)

Deprecated.

Gets the URLs for a set of specific console page. This method works exactly like getSpecificPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Parameters:

page - The portal page label of the desired console pages.

contexts - An array of contexts identifying the object each page should display or manage.

Returns:

an array of URLs for the requested pages.

Throws:

java.lang.IllegalArgumentException - if page is null or empty, if contexts is null, or if there is a problem with the information for any of the pages (e.g. pages[2] is null or an empty string). The returned array of URLs parallels the contexts array. For example, return[1] contains the result for pages[1]/contexts[1].

See Also:

getSpecificPageURL(java.lang.String, java.lang.String[])

All security roles can access this item.

getSpecificPageURLs

java.lang.String[] getSpecificPageURLs(java.lang.String[] pages,
                                       java.lang.String[][] contexts)

Deprecated.

Gets the URLs for a set of specific console pages. This method works exactly like getSpecificPageURL, except that it lets you get the URLS for a set of pages in one JMX call (to increase network performance).

Parameters:

pages - An array of portal page labels of the desired console pages.

contexts - An array of contexts identifying the object each page should display or manage.

Returns:

an array of URLs for the requested pages.

Throws:

java.lang.IllegalArgumentException - if pages or contexts is null, pages and contexts don't have the same length, or if there is a problem with the information for any of the pages (e.g. pages[2] is null or an empty string). The pages and contexts arrays are parallel arrays specifying each desired page. They must be the same length. For example, pages[1] and contexts[1] are used to indicate the information needed to compute the URL for the second page. Similarly, the returned array of URLs parallels the pages and contexts and pages arrays. For example, return[1] contains the result for pages[1]/contexts[1].

See Also:

getSpecificPageURL(java.lang.String, java.lang.String[])

All security roles can access this item.

getObjectNameContext

java.lang.String[] getObjectNameContext(java.lang.String objectName)

Deprecated.

Gets a context for a WLS mbean. This method does not check whether the mbean exists. The results of this method are usually passed into getDefaultPageURL or getSpecificPageURL.

Parameters:

objectName - the JMX object name of a WLS mbean

Returns:

a context for the WLS mbean

Throws:

java.lang.IllegalArgumentException - if objectName is null or empty

See Also:

getDefaultPageURL(java.lang.String[], java.lang.String), getSpecificPageURL(java.lang.String, java.lang.String[])

All security roles can access this item.