org.wso2.appserver.integration.common.clients

Class LogViewerClient

java.lang.Object

org.wso2.appserver.integration.common.clients.LogViewerClient

public class LogViewerClient
extends Object

This class can be used as the client to get log information from log viewer feature

Constructor Summary

Constructors

Constructor and Description
LogViewerClient(String backEndUrl, String sessionCookie)
LogViewerClient(String backEndURL, String userName, String password)

Method Summary

Methods

Modifier and Type	Method and Description
org.wso2.carbon.logging.view.stub.types.carbon.PaginatedLogFileInfo	getLocalLogFiles(int pageNumber, String tenantDomain, String serverKey) Return a paginated collection of local log file information
org.wso2.carbon.logging.view.stub.types.carbon.PaginatedLogEvent	getPaginatedApplicationLogEvents(int pageNumber, String type, String keyword, String appName, String tenantDomain, String serverKey) Get a paginated log info collection per application
org.wso2.carbon.logging.view.stub.types.carbon.PaginatedLogEvent	getPaginatedLogEvents(int pageNumber, String type, String keyword, String tenantDomain, String serverKey) Return log events of the given page (as a collection of loginfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogViewerClient

public LogViewerClient(String backEndUrl,
               String sessionCookie)
                throws org.apache.axis2.AxisFault

Throws:

org.apache.axis2.AxisFault

LogViewerClient

public LogViewerClient(String backEndURL,
               String userName,
               String password)
                throws org.apache.axis2.AxisFault

Throws:

org.apache.axis2.AxisFault

Method Detail

getPaginatedLogEvents

public org.wso2.carbon.logging.view.stub.types.carbon.PaginatedLogEvent getPaginatedLogEvents(int pageNumber,
                                                                                     String type,
                                                                                     String keyword,
                                                                                     String tenantDomain,
                                                                                     String serverKey)
                                                                                       throws RemoteException,
                                                                                              org.wso2.carbon.logging.view.stub.LogViewerLogViewerException

Return log events of the given page (as a collection of loginfo)

Parameters:

pageNumber - - page number

type - - type of the log

keyword - - keyword to search

tenantDomain - - tenant domain

serverKey - - server key

Returns:

- a paginated log event of the requested page

Throws:

RemoteException

org.wso2.carbon.logging.view.stub.LogViewerLogViewerException

getLocalLogFiles

public org.wso2.carbon.logging.view.stub.types.carbon.PaginatedLogFileInfo getLocalLogFiles(int pageNumber,
                                                                                   String tenantDomain,
                                                                                   String serverKey)
                                                                                     throws RemoteException,
                                                                                            org.wso2.carbon.logging.view.stub.LogViewerLogViewerException

Return a paginated collection of local log file information

Parameters:

pageNumber - - page number

tenantDomain - - tenant domain

serverKey - - server key

Returns:

- a paginated log file information

Throws:

RemoteException

org.wso2.carbon.logging.view.stub.LogViewerLogViewerException

getPaginatedApplicationLogEvents

public org.wso2.carbon.logging.view.stub.types.carbon.PaginatedLogEvent getPaginatedApplicationLogEvents(int pageNumber,
                                                                                                String type,
                                                                                                String keyword,
                                                                                                String appName,
                                                                                                String tenantDomain,
                                                                                                String serverKey)
                                                                                                  throws RemoteException,
                                                                                                         org.wso2.carbon.logging.view.stub.LogViewerException

Get a paginated log info collection per application

Parameters:

pageNumber - - page number

type - - type of the log

keyword - - keyword to search

appName - - application name

tenantDomain - - tenant domain

serverKey - - server key

Returns:

- a paginated log info collection

Throws:

RemoteException

org.wso2.carbon.logging.view.stub.LogViewerException