alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Glassfish example source code file (LogQuery.java)

This example Glassfish source code file (LogQuery.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Glassfish tags/keywords

first_record, helper, helper, io, last_record, list, list, log, logging, logqueryresult, long, lowest_supported_query_level, management, param, param, string, string, taxonomy, util

The Glassfish LogQuery.java source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.admin.amx.logging;

import javax.management.Attribute;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import java.io.Serializable;
import javax.management.MBeanOperationInfo;
import org.glassfish.admin.amx.annotation.*;
import org.glassfish.external.arc.Stability;
import org.glassfish.external.arc.Taxonomy;

/**
	Provides access to log messages already present in the log file.
	
	@since AS 9.0
 */
@Taxonomy(stability = Stability.UNCOMMITTED)
public interface LogQuery
{
    /**
        The lowest supported log level for which queries may be performed.
     */
    public static final String  LOWEST_SUPPORTED_QUERY_LEVEL  = Level.WARNING.toString();
    
	/**
		Query a server log file for records beginning at index <code>startIndex.
		<p>
		The <code>name parameter may be {@link LogFileAccess#MOST_RECENT_NAME}
		to query the current server log file, or may be any specific server log
		file as returned by {@link LogFileAccess#getLogFileNames}.
		<p>
		To query log records starting at the beginning of the file and moving forward,
		use startIndex={@link #FIRST_RECORD}.  To query records beginning at the end of the
		file and moving backwards, use startIndex={@link #LAST_RECORD} and
		specify <code>searchForward=false.
		<p>
		If <code>searchForward is true,
		then log records beginning with
		<code>startRecord (inclusive) and later
		are considered by the query.<br>
		If <code>searchForward is false,
		then log records beginning at
		<code>startRecord - 1 and earlier are considered by the query.
		<p>
		Because a log file  could be deleted
		<p>
		<b>QUESTIONS TO RESOLVE
		<ul>
		<li>What are the legal keys and values of 'nameValueMap'
		</ul>
		<p>

		@param name	a specific log file name or {@link LogFileAccess#MOST_RECENT_NAME}
		@param startIndex     the location within the LogFile to begin.
		@param searchForward  true to move forward, false to move backward from <code>startIndex
		@param maxRecords  the maximum number of results to be returned, {@link #ALL_RECORDS} for all
		@param fromTime        the lower bound time, may be null (inclusive)
		@param toTime          the upper bound time, may be null (exclusive)
		@param logLevel        the minimum log level to return, see {@link Level}
		@param modules		   one or more modules as defined in {@link LogModuleNames} or
		                        any valid Logger name
		@param nameValuePairs    name-value pairs to match.  Names need not be unique.
		@return LogQueryResult  when using AMX client proxy.
		                        Actual type returned from the MBean is List<Serializable[]>
		                        The first Serializable[] is a String[] which contains the field names.
		                        Subsequent Serializable[] each represent a log record with each element representing
		                        a field within that log record.
		@see LogRecordFields
		@see LogModuleNames

     Over the wire transmission of 'UnprocessedConfigChange' would require the client to have its class;
    as delivered the Object[] contains only standard JDK types.
    See the Javadoc for {@link LogQueryResult} for the order of values in the Object[].
    Clients with access to the class can use {@link SystemStatus.Helper#toLogQueryResult}
     */
      
    @ManagedOperation(impact=MBeanOperationInfo.INFO)
        public List<Serializable[]>
    queryServerLog(
    	@Param(name="logFilename") String  logFilename,
    	@Param(name="startIndex") long     startIndex,
    	@Param(name="searchForward") boolean searchForward,
        @Param(name="maxRecords") int     maxRecords,
        @Param(name="fromTime") Long    fromTime,
        @Param(name="toTime") Long    toTime,
        @Param(name="logLevel") String   logLevel,
        @Param(name="modules") Set<String>      modules,
        @Param(name="nameValuePairs") List<Attribute> 	 nameValuePairs,
        @Param(name = "anySearch") String anySearch);
    
    /**
        Value for the <code>maximumNumberOfResults parameter to
        {@link #queryServerLog} which returns all results.
     */
    public static final int ALL_RECORDS = -1;
     
    /**
        Value for the <code>startIndex parameter to
        {@link #queryServerLog}.
     */
    public static final int   FIRST_RECORD   = 0;
    
    /**
        Value for the <code>startIndex parameter to
        {@link #queryServerLog}.
     */
    public static final int   LAST_RECORD    = -1;
    
    /**
     */
    @ManagedOperation(impact=MBeanOperationInfo.INFO)
    public String[] getDiagnosticCauses(  @Param(name="messageID") String messageID, @Param(name="moduleName") String moduleName);
    
    /**
     */
    @ManagedOperation(impact=MBeanOperationInfo.INFO)
    public String[] getDiagnosticChecks( @Param(name="messageID") String messageID, @Param(name="moduleName") String moduleName);
    
    
    /**
     */
    @ManagedOperation(impact=MBeanOperationInfo.INFO)
    public String getDiagnosticURI(  @Param(name="messageID") String messageID );

       /** helper class, in particular to convert results from {@link #queryServerLog} */
    public final class Helper
    {
        private Helper()
        {
        }

        public  static LogQueryResult toLogQueryResult(final  List<Serializable[]> items)
        {
            final LogQueryResult l =  new LogQueryResultImpl(items);

            return l;
        }

    }
	
}






Other Glassfish examples (source code examples)

Here is a short list of links related to this Glassfish LogQuery.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.