001: /*
002: * BEGIN_HEADER - DO NOT EDIT
003: *
004: * The contents of this file are subject to the terms
005: * of the Common Development and Distribution License
006: * (the "License"). You may not use this file except
007: * in compliance with the License.
008: *
009: * You can obtain a copy of the license at
010: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
011: * See the License for the specific language governing
012: * permissions and limitations under the License.
013: *
014: * When distributing Covered Code, include this CDDL
015: * HEADER in each file and include the License file at
016: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
017: * If applicable add the following below this CDDL HEADER,
018: * with the fields enclosed by brackets "[]" replaced with
019: * your own identifying information: Portions Copyright
020: * [year] [name of copyright owner]
021: */
022:
023: /*
024: * @(#)ComponentLoggerMBean.java
025: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
026: *
027: * END_HEADER - DO NOT EDIT
028: */
029: package com.sun.jbi.framework;
030:
031: import java.util.logging.Logger;
032: import java.util.logging.Level;
033: import javax.management.ObjectName;
034:
035: /**
036: * This interface defines the LoggerMBean for a Component (BC or SE). This
037: * MBean acts as an agent between the JMX management service and the UI runtime
038: * to provide operations for displaying and modifying the logger levels for
039: * all loggers created by a component.
040: *
041: * @author Sun Microsystems, Inc.
042: */
043: public interface ComponentLoggerMBean {
044: /**
045: * Get the localized display name of the specified logger.
046: * @return String representing the localized display name.
047: */
048: String getDisplayName(String logName);
049:
050: /**
051: * Get the log level of the specified logger. If the level is not set,
052: * search the parent logger chain until a logger is found with a level set.
053: * @param logName the name of the logger.
054: * @return String representing log level or null if no level is set.
055: * @throws javax.jbi.JBIException if the logger is not found.
056: */
057: String getLevel(String logName) throws javax.jbi.JBIException;
058:
059: /**
060: * Get the names of all loggers controlled by this MBean.
061: * @return List a list of logger names as String objects.
062: */
063: String[] getLoggerNames();
064:
065: /**
066: * Set the log level of the specified logger to ALL.
067: * @param logName the logger name.
068: * @return 0 if operation is successful.
069: * @throws javax.jbi.JBIException if the logger is not found.
070: */
071: int setAll(String logName) throws javax.jbi.JBIException;
072:
073: /**
074: * Set the log level of the specified logger to CONFIG.
075: * @param logName the logger name.
076: * @return 0 if operation is successful.
077: * @throws javax.jbi.JBIException if the logger is not found.
078: */
079: int setConfig(String logName) throws javax.jbi.JBIException;
080:
081: /**
082: * Set the log level of the specified logger to the default, which is
083: * null to inherit the parent logger's level.
084: * @param logName the logger name.
085: * @return 0 if operation is successful.
086: * @throws javax.jbi.JBIException if the logger is not found.
087: */
088: int setDefault(String logName) throws javax.jbi.JBIException;
089:
090: /**
091: * Set the log level of the specified logger to FINE.
092: * @param logName the logger name.
093: * @return 0 if operation is successful.
094: * @throws javax.jbi.JBIException if the logger is not found.
095: */
096: int setFine(String logName) throws javax.jbi.JBIException;
097:
098: /**
099: * Set the log level of the specified logger to FINER.
100: * @param logName the logger name.
101: * @return 0 if operation is successful.
102: * @throws javax.jbi.JBIException if the logger is not found.
103: */
104: int setFiner(String logName) throws javax.jbi.JBIException;
105:
106: /**
107: * Set the log level of the specified logger to FINEST.
108: * @param logName the logger name.
109: * @return 0 if operation is successful.
110: * @throws javax.jbi.JBIException if the logger is not found.
111: */
112: int setFinest(String logName) throws javax.jbi.JBIException;
113:
114: /**
115: * Set the log level of the specified logger to INFO.
116: * @param logName the logger name.
117: * @return 0 if operation is successful.
118: * @throws javax.jbi.JBIException if the logger is not found.
119: */
120: int setInfo(String logName) throws javax.jbi.JBIException;
121:
122: /**
123: * Set the log level of the specified logger to OFF.
124: * @param logName the logger name.
125: * @return 0 if operation is successful.
126: * @throws javax.jbi.JBIException if the logger is not found.
127: */
128: int setOff(String logName) throws javax.jbi.JBIException;
129:
130: /**
131: * Set the log level of the specified logger to SEVERE.
132: * @param logName the logger name.
133: * @return 0 if operation is successful.
134: * @throws javax.jbi.JBIException if the logger is not found.
135: */
136: int setSevere(String logName) throws javax.jbi.JBIException;
137:
138: /**
139: * Set the log level of the specified logger to WARNING.
140: * @param logName the logger name.
141: * @return 0 if operation is successful.
142: * @throws javax.jbi.JBIException if the logger is not found.
143: */
144: int setWarning(String logName) throws javax.jbi.JBIException;
145: }
|