Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.log4j2plugin
Interface FileHeaderProvider

All Superinterfaces:
java.lang.Cloneable, java.io.Serializable
All Known Implementing Classes:
DefaultFileHeaderProvider, GFileHeaderProvider

public interface FileHeaderProvider
extends java.lang.Cloneable, java.io.Serializable

This interface describes the provider, used for obtaining the header of the log file or log file segment.

See Also:
DefaultFileHeaderProvider

Method Summary
 FileHeaderProvider clone()
          Creates and returns a copy of this object.
 java.lang.String getApplicationHost()
          The Application Host to be used in the file header.
 java.lang.String getApplicationId()
          The Application Id to be used in the file header.
 java.lang.String getApplicationName()
          The Application Name to be used in the file header.
 java.lang.String getApplicationType()
          The Application Type to be used in the file header.
 java.lang.String getCommandLine()
          The Application Command Line value to be used in the file header.
 java.lang.String getFileHeader()
          This method is called for obtaining the log file header.
 void setFileName(java.lang.String fileName)
          Sets the FileName attribute of the header.
 void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
          Sets custom application properties.
 

Method Detail

setFileName

void setFileName(java.lang.String fileName)
Sets the FileName attribute of the header.

Parameters:
fileName - the file name attribute value.

setProperties

void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
Sets custom application properties.

Parameters:
properties - the application properties.

getFileHeader

java.lang.String getFileHeader()
This method is called for obtaining the log file header.

Returns:
The string which will be used as header for the log file or segment.

getApplicationName

java.lang.String getApplicationName()
The Application Name to be used in the file header.


getApplicationHost

java.lang.String getApplicationHost()
The Application Host to be used in the file header.


getApplicationType

java.lang.String getApplicationType()
The Application Type to be used in the file header.


getApplicationId

java.lang.String getApplicationId()
The Application Id to be used in the file header.


getCommandLine

java.lang.String getCommandLine()
The Application Command Line value to be used in the file header.


clone

FileHeaderProvider clone()
Creates and returns a copy of this object.

Returns:
a clone of this instance
See Also:
Cloneable

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.