-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
JobEntryWriteToLog.java
376 lines (317 loc) · 10.6 KB
/
JobEntryWriteToLog.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
/*! ******************************************************************************
*
* Pentaho Data Integration
*
* Copyright (C) 2002-2017 by Pentaho : http://www.pentaho.com
*
*******************************************************************************
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
******************************************************************************/
package org.pentaho.di.job.entries.writetolog;
import java.util.Date;
import java.util.List;
import org.pentaho.di.cluster.SlaveServer;
import org.pentaho.di.core.Const;
import org.pentaho.di.core.util.Utils;
import org.pentaho.di.core.Result;
import org.pentaho.di.core.database.DatabaseMeta;
import org.pentaho.di.core.exception.KettleDatabaseException;
import org.pentaho.di.core.exception.KettleException;
import org.pentaho.di.core.exception.KettleXMLException;
import org.pentaho.di.core.logging.LogChannel;
import org.pentaho.di.core.logging.LogChannelInterface;
import org.pentaho.di.core.logging.LogLevel;
import org.pentaho.di.core.logging.LoggingObjectInterface;
import org.pentaho.di.core.logging.LoggingObjectType;
import org.pentaho.di.core.xml.XMLHandler;
import org.pentaho.di.i18n.BaseMessages;
import org.pentaho.di.job.entry.JobEntryBase;
import org.pentaho.di.job.entry.JobEntryInterface;
import org.pentaho.di.repository.ObjectId;
import org.pentaho.di.repository.ObjectRevision;
import org.pentaho.di.repository.Repository;
import org.pentaho.di.repository.RepositoryDirectory;
import org.pentaho.metastore.api.IMetaStore;
import org.w3c.dom.Node;
/**
* Job entry type to output message to the job log.
*
* @author Samatar
* @since 08-08-2007
*/
public class JobEntryWriteToLog extends JobEntryBase implements Cloneable, JobEntryInterface {
private static Class<?> PKG = JobEntryWriteToLog.class; // for i18n purposes, needed by Translator2!!
/**
* The log level with which the message should be logged.
*
* @deprecated Use {@link JobEntryWriteToLog#getEntryLogLevel()} and
* {@link JobEntryWriteToLog#setEntryLogLevel(LogLevel)} instead.
*/
@Deprecated
public LogLevel entryLogLevel;
private String logsubject;
private String logmessage;
public JobEntryWriteToLog( String n ) {
super( n, "" );
logmessage = null;
logsubject = null;
}
public JobEntryWriteToLog() {
this( "" );
}
@Override
public Object clone() {
JobEntryWriteToLog je = (JobEntryWriteToLog) super.clone();
return je;
}
@Override
public String getXML() {
StringBuilder retval = new StringBuilder( 200 );
retval.append( super.getXML() );
retval.append( " " ).append( XMLHandler.addTagValue( "logmessage", logmessage ) );
retval.append( " " ).append(
XMLHandler.addTagValue( "loglevel", ( getEntryLogLevel() == null ) ? null : getEntryLogLevel().getCode() ) );
retval.append( " " ).append( XMLHandler.addTagValue( "logsubject", logsubject ) );
return retval.toString();
}
@Override
public void loadXML( Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers,
Repository rep, IMetaStore metaStore ) throws KettleXMLException {
try {
super.loadXML( entrynode, databases, slaveServers );
logmessage = XMLHandler.getTagValue( entrynode, "logmessage" );
entryLogLevel = LogLevel.getLogLevelForCode( XMLHandler.getTagValue( entrynode, "loglevel" ) );
logsubject = XMLHandler.getTagValue( entrynode, "logsubject" );
} catch ( Exception e ) {
throw new KettleXMLException( BaseMessages.getString( PKG, "WriteToLog.Error.UnableToLoadFromXML.Label" ), e );
}
}
@Override
public void loadRep( Repository rep, IMetaStore metaStore, ObjectId id_jobentry, List<DatabaseMeta> databases,
List<SlaveServer> slaveServers ) throws KettleException {
try {
logmessage = rep.getJobEntryAttributeString( id_jobentry, "logmessage" );
entryLogLevel = LogLevel.getLogLevelForCode( rep.getJobEntryAttributeString( id_jobentry, "loglevel" ) );
logsubject = rep.getJobEntryAttributeString( id_jobentry, "logsubject" );
} catch ( KettleDatabaseException dbe ) {
throw new KettleException( BaseMessages.getString( PKG, "WriteToLog.Error.UnableToLoadFromRepository.Label" )
+ id_jobentry, dbe );
}
}
// Save the attributes of this job entry
//
@Override
public void saveRep( Repository rep, IMetaStore metaStore, ObjectId id_job ) throws KettleException {
try {
rep.saveJobEntryAttribute( id_job, getObjectId(), "logmessage", logmessage );
rep.saveJobEntryAttribute( id_job, getObjectId(), "loglevel", ( entryLogLevel != null ? entryLogLevel
.getCode() : "" ) );
rep.saveJobEntryAttribute( id_job, getObjectId(), "logsubject", logsubject );
} catch ( KettleDatabaseException dbe ) {
throw new KettleException( BaseMessages.getString( PKG, "WriteToLog.Error.UnableToSaveToRepository.Label" )
+ id_job, dbe );
}
}
private class LogWriterObject implements LoggingObjectInterface {
private LogChannelInterface writerLog;
private LogLevel logLevel;
private LoggingObjectInterface parent;
private String subject;
private String containerObjectId;
public LogWriterObject( String subject, LoggingObjectInterface parent, LogLevel logLevel ) {
this.subject = subject;
this.parent = parent;
this.logLevel = logLevel;
this.writerLog = new LogChannel( this, parent );
this.containerObjectId = writerLog.getContainerObjectId();
}
@Override
public String getFilename() {
return null;
}
@Override
public String getLogChannelId() {
return writerLog.getLogChannelId();
}
@Override
public String getObjectCopy() {
return null;
}
@Override
public ObjectId getObjectId() {
return null;
}
@Override
public String getObjectName() {
return subject;
}
@Override
public ObjectRevision getObjectRevision() {
return null;
}
@Override
public LoggingObjectType getObjectType() {
return LoggingObjectType.STEP;
}
@Override
public LoggingObjectInterface getParent() {
return parent;
}
@Override
public RepositoryDirectory getRepositoryDirectory() {
return null;
}
public LogChannelInterface getLogChannel() {
return writerLog;
}
@Override
public LogLevel getLogLevel() {
return logLevel;
}
/**
* @return the execution container object id
*/
@Override
public String getContainerObjectId() {
return containerObjectId;
}
/**
* Stub
*/
@Override
public Date getRegistrationDate() {
return null;
}
@Override
public boolean isGatheringMetrics() {
return log.isGatheringMetrics();
}
@Override
public void setGatheringMetrics( boolean gatheringMetrics ) {
log.setGatheringMetrics( gatheringMetrics );
}
@Override
public boolean isForcingSeparateLogging() {
return log.isForcingSeparateLogging();
}
@Override
public void setForcingSeparateLogging( boolean forcingSeparateLogging ) {
log.setForcingSeparateLogging( forcingSeparateLogging );
}
}
LogChannelInterface createLogChannel() {
LogWriterObject logWriterObject = new LogWriterObject( getRealLogSubject(), this, parentJob.getLogLevel() );
return logWriterObject.getLogChannel();
}
/**
* Output message to job log.
*/
public boolean evaluate( Result result ) {
LogChannelInterface logChannel = createLogChannel();
String message = getRealLogMessage();
// Filter out empty messages and those that are not visible with the job's log level
if ( Utils.isEmpty( message ) || !getEntryLogLevel().isVisible( logChannel.getLogLevel() ) ) {
return true;
}
try {
switch ( getEntryLogLevel() ) {
case ERROR:
logChannel.logError( message + Const.CR );
break;
case MINIMAL:
logChannel.logMinimal( message + Const.CR );
break;
case BASIC:
logChannel.logBasic( message + Const.CR );
break;
case DETAILED:
logChannel.logDetailed( message + Const.CR );
break;
case DEBUG:
logChannel.logDebug( message + Const.CR );
break;
case ROWLEVEL:
logChannel.logRowlevel( message + Const.CR );
break;
default: // NOTHING
break;
}
return true;
} catch ( Exception e ) {
result.setNrErrors( 1 );
log.logError( BaseMessages.getString( PKG, "WriteToLog.Error.Label" ), BaseMessages.getString(
PKG, "WriteToLog.Error.Description" )
+ " : " + e.toString() );
return false;
}
}
/**
* Execute this job entry and return the result. In this case it means, just set the result boolean in the Result
* class.
*
* @param prev_result
* The result of the previous execution
* @return The Result of the execution.
*/
@Override
public Result execute( Result prev_result, int nr ) {
prev_result.setResult( evaluate( prev_result ) );
return prev_result;
}
@Override
public boolean resetErrorsBeforeExecution() {
// we should be able to evaluate the errors in
// the previous jobentry.
return false;
}
@Override
public boolean evaluates() {
return true;
}
@Override
public boolean isUnconditional() {
return false;
}
public String getRealLogMessage() {
return Const.NVL( environmentSubstitute( getLogMessage() ), "" );
}
public String getRealLogSubject() {
return Const.NVL( environmentSubstitute( getLogSubject() ), "" );
}
public String getLogMessage() {
if ( logmessage == null ) {
logmessage = "";
}
return logmessage;
}
public String getLogSubject() {
if ( logsubject == null ) {
logsubject = "";
}
return logsubject;
}
public void setLogMessage( String s ) {
logmessage = s;
}
public void setLogSubject( String logsubjectin ) {
logsubject = logsubjectin;
}
public LogLevel getEntryLogLevel() {
return entryLogLevel;
}
public void setEntryLogLevel( LogLevel in ) {
this.entryLogLevel = in;
}
}