com.sapportals.wcm.service.applog

Interface IAppLogRetriever

Deprecated. As of NetWeaver 7.1, replaced by the SAP Logging API.

public interface IAppLogRetriever

Retrieve Application Log Entries

See Also:

com.sap.tc.logging

Field Summary

static int	MATCH_APPLICATION Deprecated.
static int	MATCH_CURRENT_URI Deprecated.
static int	MATCH_LOG_TEXT Deprecated.
static int	MATCH_NONE Deprecated.
static int	MATCH_ORIGINAL_URI Deprecated.
static int	MATCH_PARAMETERS Deprecated.
static int	SORT_KEY_APP_ID Deprecated.
static int	SORT_KEY_DATE Deprecated.
static int	SORT_KEY_LOG_LEVEL Deprecated.
static int	SORT_KEY_PRIMAL_URI Deprecated.
static int	SORT_KEY_PRINCIPAL Deprecated.

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) Deprecated. Retrieve application log entries
IAppLogEntryList	retrieve(Integer logLevel, Date dateFrom, Date dateTo, String appId, com.sapportals.portal.security.usermanagement.IUMPrincipal principal, Integer sortKey) Deprecated. As of NetWeaver 7.1, replaced by retrieve(boolean,boolean,boolean,boolean,boolean,boolean,Date,Date,int,String,int,String,Integer)
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) Deprecated. 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) Deprecated. As of NetWeaver 7.1, replaced by retrieve2file(String,boolean,boolean,boolean,boolean,boolean,boolean,Date,Date,int,String,int,String,Integer)
boolean	retrieve2fileUME(String filename, Integer logLevel, Date dateFrom, Date dateTo, String appId, IPrincipal principal, Integer sortKey) Deprecated. As of NetWeaver 7.1, replaced by the SAP Logging API.
IAppLogEntryList	retrieveUME(Integer logLevel, Date dateFrom, Date dateTo, String appId, IPrincipal principal, Integer sortKey) Deprecated. As of NetWeaver 7.1, replaced by the SAP Logging API.

Field Detail

MATCH_NONE

static final int MATCH_NONE

Deprecated.

See Also:

Constant Field Values

MATCH_APPLICATION

static final int MATCH_APPLICATION

Deprecated.

See Also:

Constant Field Values

MATCH_LOG_TEXT

static final int MATCH_LOG_TEXT

Deprecated.

See Also:

Constant Field Values

MATCH_PARAMETERS

static final int MATCH_PARAMETERS

Deprecated.

See Also:

Constant Field Values

MATCH_ORIGINAL_URI

static final int MATCH_ORIGINAL_URI

Deprecated.

See Also:

Constant Field Values

MATCH_CURRENT_URI

static final int MATCH_CURRENT_URI

Deprecated.

See Also:

Constant Field Values

SORT_KEY_LOG_LEVEL

static final int SORT_KEY_LOG_LEVEL

Deprecated.

See Also:

Constant Field Values

SORT_KEY_DATE

static final int SORT_KEY_DATE

Deprecated.

See Also:

Constant Field Values

SORT_KEY_APP_ID

static final int SORT_KEY_APP_ID

Deprecated.

See Also:

Constant Field Values

SORT_KEY_PRINCIPAL

static final int SORT_KEY_PRINCIPAL

Deprecated.

See Also:

Constant Field Values

SORT_KEY_PRIMAL_URI

static final int SORT_KEY_PRIMAL_URI

Deprecated.

See Also:

Constant Field Values

Method Detail

retrieve

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

Deprecated. As of NetWeaver 7.1, replaced by retrieve(boolean,boolean,boolean,boolean,boolean,boolean,Date,Date,int,String,int,String,Integer)

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

retrieveUME

IAppLogEntryList retrieveUME(Integer logLevel,
                             Date dateFrom,
                             Date dateTo,
                             String appId,
                             IPrincipal principal,
                             Integer sortKey)
                             throws AppLogException

Deprecated. As of NetWeaver 7.1, replaced by the SAP Logging API.

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

See Also:

com.sap.tc.logging

retrieve2file

boolean retrieve2file(String filename,
                      Integer logLevel,
                      Date dateFrom,
                      Date dateTo,
                      String appId,
                      com.sapportals.portal.security.usermanagement.IUMPrincipal principal,
                      Integer sortKey)
                      throws AppLogException

Deprecated. As of NetWeaver 7.1, replaced by retrieve2file(String,boolean,boolean,boolean,boolean,boolean,boolean,Date,Date,int,String,int,String,Integer)

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

retrieve2fileUME

boolean retrieve2fileUME(String filename,
                         Integer logLevel,
                         Date dateFrom,
                         Date dateTo,
                         String appId,
                         IPrincipal principal,
                         Integer sortKey)
                         throws AppLogException

Deprecated. As of NetWeaver 7.1, replaced by the SAP Logging API.

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

See Also:

com.sap.tc.logging

retrieve

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

Deprecated.

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 (will be ignored!)

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

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

Deprecated.

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 (will be ignored!)

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

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM