ConsoleRuntimeMBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Runtime services for the console.

Deprecated. 14.1.2.0.0

       
Since10.3.1.0
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.runtime.ConsoleRuntimeMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:
    Access Points Inherited from RuntimeMBean Because this MBean extends or implements RuntimeMBean, you can also access this MBean by retrieving RuntimeMBeans. The following attributes contain RuntimeMBeans and its subtypes:

    Attributes

    This section describes the following attributes:

    CachingDisabled

    Private property that disables caching in proxies.

           
    Privileges Read only
    Typeboolean

    Enabled

    Is the console enabled?

           
    Available Since Release 10.3.1.0
    Privileges Read only
    Typeboolean

    HomePageURL

    Gets the URL for the console's home page

           
    Available Since Release 10.3.1.0
    Privileges Read only
    Typejava.lang.String

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo

    Name

    The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

           
    Privileges Read only
    Typejava.lang.String

    ObjectName

    Returns the ObjectName under which this MBean is registered in the MBean server.

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    Registered

    Returns false if the MBean represented by this object has been unregistered.

    Deprecated.

           
    Privileges Read only
    Typeboolean

    Type

    Returns the type of the MBean.

           
    Privileges Read only
    Typejava.lang.String

    Operations

    This section describes the following operations:

    getDefaultPageURL

    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.

    For more information, see:

       
    Operation Name"getDefaultPageURL"
    ParametersObject [] {  context, perspective }

    where:

    • context is an object of type [Ljava.lang.String; that specifies:

      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 is an object of type java.lang.String that specifies:

      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.
    SignatureString [] { "[Ljava.lang.String;", "java.lang.String" }
    ReturnsString

    getDefaultPageURLs

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

    For more information, see:

       
    Operation Name"getDefaultPageURLs"
    ParametersObject [] {  contexts, perspectives }

    where:

    • contexts is an object of type [[Ljava.lang.String; that specifies:

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

    • perspectives is an object of type [Ljava.lang.String; that specifies:

      An array of perspectives identifying which kind of default page to return for each object.
    SignatureString [] { "[[Ljava.lang.String;", "[Ljava.lang.String;" }
    Returns class

    getDefaultPageURLs

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

    For more information, see:

       
    Operation Name"getDefaultPageURLs"
    ParametersObject [] {  contexts, perspective }

    where:

    • contexts is an object of type [[Ljava.lang.String; that specifies:

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

    • perspective is an object of type java.lang.String that specifies:

      Specifies which kind of default page to return for all of the pages.
    SignatureString [] { "[[Ljava.lang.String;", "java.lang.String" }
    Returns class

    getObjectNameContext

    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.

    For more information, see:

       
    Operation Name"getObjectNameContext"
    ParametersObject [] {  objectName }

    where:

    • objectName is an object of type java.lang.String that specifies:

      the JMX object name of a WLS mbean
    SignatureString [] { "java.lang.String" }
    Returns class

    getSpecificPageURL

    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.

    For more information, see:

       
    Operation Name"getSpecificPageURL"
    ParametersObject [] {  page, context }

    where:

    • page is an object of type java.lang.String that specifies:

      The portal page label of the desired console page.

    • context is an object of type [Ljava.lang.String; that specifies:

      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.
    SignatureString [] { "java.lang.String", "[Ljava.lang.String;" }
    ReturnsString

    getSpecificPageURLs

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

    For more information, see:

       
    Operation Name"getSpecificPageURLs"
    ParametersObject [] {  page, contexts }

    where:

    • page is an object of type java.lang.String that specifies:

      The portal page label of the desired console pages.

    • contexts is an object of type [[Ljava.lang.String; that specifies:

      An array of contexts identifying the object each page should display or manage.
    SignatureString [] { "java.lang.String", "[[Ljava.lang.String;" }
    Returns class

    getSpecificPageURLs

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

    For more information, see:

       
    Operation Name"getSpecificPageURLs"
    ParametersObject [] {  pages, contexts }

    where:

    • pages is an object of type [Ljava.lang.String; that specifies:

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

    • contexts is an object of type [[Ljava.lang.String; that specifies:

      An array of contexts identifying the object each page should display or manage.
    SignatureString [] { "[Ljava.lang.String;", "[[Ljava.lang.String;" }
    Returns class