Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.sapportals.wcm.service.applog

Interface IAppLogRetriever

public interface IAppLogRetriever

Retrieve Application Log Entries

Field Summary
static int MATCH_APPLICATION
           
static int MATCH_CURRENT_URI
           
static int MATCH_LOG_TEXT
           
static int MATCH_NONE
           
static int MATCH_ORIGINAL_URI
           
static int MATCH_PARAMETERS
           
static int SORT_KEY_APP_ID
           
static int SORT_KEY_DATE
           
static int SORT_KEY_LOG_LEVEL
           
static int SORT_KEY_PRIMAL_URI
           
static int SORT_KEY_PRINCIPAL
           
 
Method Summary
 IAppLogEntryList retrieve(boolean error, boolean warning, boolean control, boolean info, boolean debug, boolean data, Date dateFrom, Date dateTo, int matchType, String matchText, int principalType, String principalName, Integer sortKey)
          Retrieve application log entries
 IAppLogEntryList retrieve(Integer logLevel, Date dateFrom, Date dateTo, String appId, com.sapportals.portal.security.usermanagement.IUMPrincipal principal, Integer sortKey)
          Retrieve application log entries
 boolean retrieve2file(String filename, boolean error, boolean warning, boolean control, boolean info, boolean debug, boolean data, Date dateFrom, Date dateTo, int matchType, String matchText, int principalType, String principalName, Integer sortKey)
          Retrieve application log entries and store them in a file
 boolean retrieve2file(String filename, Integer logLevel, Date dateFrom, Date dateTo, String appId, com.sapportals.portal.security.usermanagement.IUMPrincipal principal, Integer sortKey)
          Retrieve application log entries and store them in a file
 

Field Detail

MATCH_NONE

public static final int MATCH_NONE
See Also:
Constant Field Values

MATCH_APPLICATION

public static final int MATCH_APPLICATION
See Also:
Constant Field Values

MATCH_LOG_TEXT

public static final int MATCH_LOG_TEXT
See Also:
Constant Field Values

MATCH_PARAMETERS

public static final int MATCH_PARAMETERS
See Also:
Constant Field Values

MATCH_ORIGINAL_URI

public static final int MATCH_ORIGINAL_URI
See Also:
Constant Field Values

MATCH_CURRENT_URI

public static final int MATCH_CURRENT_URI
See Also:
Constant Field Values

SORT_KEY_LOG_LEVEL

public static final int SORT_KEY_LOG_LEVEL
See Also:
Constant Field Values

SORT_KEY_DATE

public static final int SORT_KEY_DATE
See Also:
Constant Field Values

SORT_KEY_APP_ID

public static final int SORT_KEY_APP_ID
See Also:
Constant Field Values

SORT_KEY_PRINCIPAL

public static final int SORT_KEY_PRINCIPAL
See Also:
Constant Field Values

SORT_KEY_PRIMAL_URI

public static final int SORT_KEY_PRIMAL_URI
See Also:
Constant Field Values
Method Detail

retrieve

public IAppLogEntryList retrieve(Integer logLevel,
                                 Date dateFrom,
                                 Date dateTo,
                                 String appId,
                                 com.sapportals.portal.security.usermanagement.IUMPrincipal principal,
                                 Integer sortKey)
                          throws AppLogException
Retrieve application log entries

Parameters:
logLevel - maximum level for entries (null for all levels)
dateFrom - don't retrieve entries which are older (may be null)
dateTo - don't retrieve entries which are younger (may be null)
appId - the application attribute of the entry must contain this text (may be null)
principal - principal to search for (may be null)
sortKey - specifies the sorting of the returned entries (may be null)
Returns:
the matching entries
Throws:
AppLogException - thrown in case of error

retrieve2file

public boolean retrieve2file(String filename,
                             Integer logLevel,
                             Date dateFrom,
                             Date dateTo,
                             String appId,
                             com.sapportals.portal.security.usermanagement.IUMPrincipal principal,
                             Integer sortKey)
                      throws AppLogException
Retrieve application log entries and store them in a file

Parameters:
filename - the name of the file where the matching entries are stored
logLevel - maximum level for entries (null for all levels)
dateFrom - don't retrieve entries which are older (may be null)
dateTo - don't retrieve entries which are younger (may be null)
appId - the application attribute of the entry must contain this text (may be null)
principal - principal to search for (may be null)
sortKey - specifies the sorting of the returned entries (may be null)
Returns:
true iff the file was written successfully
Throws:
AppLogException - thrown in case of error

retrieve

public IAppLogEntryList retrieve(boolean error,
                                 boolean warning,
                                 boolean control,
                                 boolean info,
                                 boolean debug,
                                 boolean data,
                                 Date dateFrom,
                                 Date dateTo,
                                 int matchType,
                                 String matchText,
                                 int principalType,
                                 String principalName,
                                 Integer sortKey)
                          throws AppLogException
Retrieve application log entries

Parameters:
error - include entries of log level error?
warning - include entries of log level warning?
control - include entries of log level control?
info - include entries of log level info?
debug - include entries of log level debug?
data - include entries of log level data?
dateFrom - don't retrieve entries which are older (may be null)
dateTo - don't retrieve entries which are younger (may be null)
matchType - the speficied entry attribute must contain the matchText
matchText - text which must be part of the entry attribute specified by matchType (may be null)
principalType - type of the principal to search for
principalName - name of the principal to search for (may be null)
sortKey - specifies the sorting of the returnes entries (may be null)
Returns:
the matching entries
Throws:
AppLogException - thrown in case of error

retrieve2file

public boolean retrieve2file(String filename,
                             boolean error,
                             boolean warning,
                             boolean control,
                             boolean info,
                             boolean debug,
                             boolean data,
                             Date dateFrom,
                             Date dateTo,
                             int matchType,
                             String matchText,
                             int principalType,
                             String principalName,
                             Integer sortKey)
                      throws AppLogException
Retrieve application log entries and store them in a file

Parameters:
filename - the name of the file where the matching entries are stored
error - include entries of log level error?
warning - include entries of log level warning?
control - include entries of log level control?
info - include entries of log level info?
debug - include entries of log level debug?
data - include entries of log level data?
dateFrom - don't retrieve entries which are older (may be null)
dateTo - don't retrieve entries which are younger (may be null)
matchType - the speficied entry attribute must contain the matchText
matchText - text which must be part of the entry attribute specified by matchType (may be null)
principalType - type of the principal to search for
principalName - name of the principal to search for (may be null)
sortKey - specifies the sorting of the returnes entries (may be null)
Returns:
true iff the file was written successfully
Throws:
AppLogException - thrown in case of error
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.