|
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 |
public interface ConsoleRuntimeMBean
Runtime services for the console.
Method Summary | |
---|---|
abstract String |
getDefaultPageURL(String[] context, String perspective) Gets the URL for the default page of an object. |
abstract String[] |
getDefaultPageURLs(String[][] contexts, String perspective) Gets the URLs for the default pages for a set of objects. |
abstract String[] |
getDefaultPageURLs(String[][] contexts, String[] perspectives) Gets the URLs for the default pages for a set of objects. |
abstract String |
getHomePageURL() Gets the URL for the console's home page |
abstract String[] |
getObjectNameContext(String objectName) Gets a context for a WLS mbean. |
abstract String |
getSpecificPageURL(String page, String[] context) Gets the URL for a specific console page. |
abstract String[] |
getSpecificPageURLs(String[] pages, String[][] contexts) Gets the URLs for a set of specific console pages. |
abstract String[] |
getSpecificPageURLs(String page, String[][] contexts) Gets the URLs for a set of specific console page. |
abstract boolean |
isEnabled() Is the console enabled? |
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 |
Methods inherited from interface javax.management.DynamicMBean |
---|
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
---|
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
---|
addNotificationListener, getNotificationInfo, removeNotificationListener |
Method Detail |
---|
boolean isEnabled()
String getHomePageURL()
String getDefaultPageURL(String[] context, String perspective)
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.IllegalArgumentException
- if context is null or emptyConsoleRuntimeMBean.getObjectNameContext(java.lang.String)
String[] getDefaultPageURLs(String[][] contexts, String perspective)
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.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].ConsoleRuntimeMBean.getDefaultPageURL(java.lang.String[], java.lang.String)
String[] getDefaultPageURLs(String[][] contexts, String[] perspectives)
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.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].ConsoleRuntimeMBean.getDefaultPageURL(java.lang.String[], java.lang.String)
String getSpecificPageURL(String page, String[] context)
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.IllegalArgumentException
- if page is null or emptyConsoleRuntimeMBean.getDefaultPageURL(java.lang.String[], java.lang.String)
String[] getSpecificPageURLs(String page, String[][] contexts)
page
- The portal page label of the desired console pages.contexts
- An array of contexts identifying the object each page should display or manage.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].ConsoleRuntimeMBean.getSpecificPageURL(java.lang.String, java.lang.String[])
String[] getSpecificPageURLs(String[] pages, String[][] contexts)
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.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].ConsoleRuntimeMBean.getSpecificPageURL(java.lang.String, java.lang.String[])
String[] getObjectNameContext(String objectName)
objectName
- the JMX object name of a WLS mbeanIllegalArgumentException
- if objectName is null or emptyConsoleRuntimeMBean.getDefaultPageURL(java.lang.String[], java.lang.String)
, ConsoleRuntimeMBean.getSpecificPageURL(java.lang.String, java.lang.String[])
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. 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 |