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 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
|
/*
* Copyright (c) 1998, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Oracle - initial API and implementation from Oracle TopLink
package org.eclipse.persistence.logging;
import java.io.Writer;
import org.eclipse.persistence.sessions.Session;
/**
* SessionLog is the ever-so-simple interface used by
* EclipseLink to log generated messages and SQL. An implementor of
* this interface can be passed to the EclipseLink session
* (via the #setSessionLog(SessionLog) method); and
* all logging data will be passed through to the implementor
* via an instance of SessionLogEntry. This can be used
* to supplement debugging; or the entries could be stored
* in a database instead of logged to System.out, etc.
* <p>
* This class defines Eclipselink logging levels (that are used throughout EclipseLink code) with the following integer values:
* <table summary="">
* <tr><td> </td><td>ALL</td> <td> </td><td>= {@value #ALL}</td></tr>
* <tr><td> </td><td>FINEST</td> <td> </td><td>= {@value #FINEST}</td></tr>
* <tr><td> </td><td>FINER</td> <td> </td><td>= {@value #FINER}</td></tr>
* <tr><td> </td><td>FINE</td> <td> </td><td>= {@value #FINE}</td></tr>
* <tr><td> </td><td>CONFIG</td> <td> </td><td>= {@value #CONFIG}</td></tr>
* <tr><td> </td><td>INFO</td> <td> </td><td>= {@value #INFO}</td></tr>
* <tr><td> </td><td>WARNING</td><td> </td><td>= {@value #WARNING}</td></tr>
* <tr><td> </td><td>SEVERE</td> <td> </td><td>= {@value #SEVERE}</td></tr>
* <tr><td> </td><td>OFF</td> <td> </td><td>= {@value #OFF}</td></tr>
* </table>
* <p>
* In addition, EclipseLink categories used for logging name space are defined with the following String values:
* <table summary="">
* <tr><td> </td><td>{@link #CACHE}</td> <td> </td><td>= {@value #CACHE}</td></tr>
* <tr><td> </td><td>{@link #CONNECTION}</td> <td> </td><td>= {@value #CONNECTION}</td></tr>
* <tr><td> </td><td>{@link #DMS}</td> <td> </td><td>= {@value #DMS}</td></tr>
* <tr><td> </td><td>{@link #EJB}</td> <td> </td><td>= {@value #EJB}</td></tr>
* <tr><td> </td><td>{@link #EVENT}</td> <td> </td><td>= {@value #EVENT}</td></tr>
* <tr><td> </td><td>{@link #DBWS}</td> <td> </td><td>= {@value #DBWS}</td></tr>
* <tr><td> </td><td>{@link #JPARS}</td> <td> </td><td>= {@value #JPARS}</td></tr>
* <tr><td> </td><td>{@link #METADATA}</td> <td> </td><td>= {@value #METADATA} </td></tr>
* <tr><td> </td><td>{@link #METAMODEL}</td> <td> </td><td>= {@value #METAMODEL}</td></tr>
* <tr><td> </td><td>{@link #MOXY}</td> <td> </td><td>= {@value #MOXY}</td></tr>
* <tr><td> </td><td>{@link #PROCESSOR}</td> <td> </td><td>= {@value #PROCESSOR}</td></tr>
* <tr><td> </td><td>{@link #PROPAGATION}</td> <td> </td><td>= {@value #PROPAGATION}</td></tr>
* <tr><td> </td><td>{@link #PROPERTIES}</td> <td> </td><td>= {@value #PROPERTIES}</td></tr>
* <tr><td> </td><td>{@link #QUERY}</td> <td> </td><td>= {@value #QUERY}</td></tr>
* <tr><td> </td><td>{@link #SEQUENCING}</td> <td> </td><td>= {@value #SEQUENCING}</td></tr>
* <tr><td> </td><td>{@link #SERVER}</td> <td> </td><td>= {@value #SERVER}</td></tr>
* <tr><td> </td><td>{@link #SQL}</td> <td> </td><td>= {@value #SQL}</td></tr>
* <tr><td> </td><td>{@link #THREAD}</td> <td> </td><td>= {@value #THREAD}</td></tr>
* <tr><td> </td><td>{@link #TRANSACTION}</td> <td> </td><td>= {@value #TRANSACTION}</td></tr>
* <tr><td> </td><td>{@link #WEAVER}</td> <td> </td><td>= {@value #WEAVER}</td></tr>
* </table>
*
* @see AbstractSessionLog
* @see SessionLogEntry
* @see Session
*
* @since TOPLink/Java 3.0
*/
public interface SessionLog extends Cloneable {
// EclipseLink log levels. They are mapped to java.util.logging.Level values.
// Numeric constants can't be replaced with LogLevel.<level>.getId();
public static final int OFF = 8;
public static final String OFF_LABEL = LogLevel.OFF.getName();
//EL is not in a state to continue
public static final int SEVERE = 7;
public static final String SEVERE_LABEL = LogLevel.SEVERE.getName();
//Exceptions that don't force a stop
public static final int WARNING = 6;
public static final String WARNING_LABEL = LogLevel.WARNING.getName();
//Login and logout per server session with name
public static final int INFO = 5;
public static final String INFO_LABEL = LogLevel.INFO.getName();
//Configuration info
public static final int CONFIG = 4;
public static final String CONFIG_LABEL = LogLevel.CONFIG.getName();
//SQL
public static final int FINE = 3;
public static final String FINE_LABEL = LogLevel.FINE.getName();
//Previously logged under logMessage and stack trace of exceptions at WARNING level
public static final int FINER = 2;
public static final String FINER_LABEL = LogLevel.FINER.getName();
//Previously logged under logDebug
public static final int FINEST = 1;
public static final String FINEST_LABEL = LogLevel.FINEST.getName();
public static final int ALL = 0;
public static final String ALL_LABEL = LogLevel.ALL.getName();
//EclipseLink categories used for logging name space.
public static final String SQL = "sql";
public static final String TRANSACTION = "transaction";
public static final String EVENT = "event";
public static final String CONNECTION = "connection";
public static final String QUERY = "query";
public static final String CACHE = "cache";
public static final String PROPAGATION = "propagation";
public static final String SEQUENCING = "sequencing";
public static final String JPA = "jpa";
public static final String EJB = "ejb";
public static final String DMS = "dms";
public static final String METADATA = "metadata";
public static final String MONITORING = "monitoring";
public static final String MISC = "misc";
public static final String MOXY = "moxy";
/** @deprecated use {@link #METADATA}. */
@Deprecated
public static final String EJB_OR_METADATA = METADATA;
public static final String METAMODEL = "metamodel";
public static final String WEAVER = "weaver";
public static final String PROPERTIES = "properties";
public static final String SERVER = "server";
public static final String DDL = "ddl";
public static final String DBWS = "dbws";
public static final String JPARS = "jpars";
/** ModelGen logging name space. */
public static final String PROCESSOR = "processor";
public static final String THREAD = "thread";
public final String[] loggerCatagories = new String[] {
SQL,
TRANSACTION,
EVENT,
CONNECTION,
QUERY,
CACHE,
PROPAGATION,
SEQUENCING,
JPA,
DBWS,
JPARS,
EJB,
DMS,
METADATA,
MONITORING,
MOXY,
METAMODEL,
WEAVER,
PROPERTIES,
SERVER,
DDL,
PROCESSOR,
THREAD
};
/**
* PUBLIC:
* EclipseLink will call this method whenever something
* needs to be logged (messages, SQL, etc.).
* All the pertinent information will be contained in
* the specified entry.
*
* @param entry org.eclipse.persistence.sessions.LogEntry
*/
public void log(SessionLogEntry entry);
/**
* By default the stack trace is logged for SEVERE all the time and at FINER level for WARNING or less,
* this can be turned off.
*/
public boolean shouldLogExceptionStackTrace();
/**
* By default the date is always printed, this can be turned off.
*/
public boolean shouldPrintDate();
/**
* By default the thread is logged at FINE or less level, this can be turned off.
*/
public boolean shouldPrintThread();
/**
* Return whether bind parameters should be displayed when logging SQL, default is true.
*/
public boolean shouldDisplayData();
/**
* By default the connection is always printed whenever available, this can be turned off.
*/
public boolean shouldPrintConnection();
/**
* By default the Session is always printed whenever available, this can be turned off.
*/
public boolean shouldPrintSession();
/**
* Set whether bind parameters should be displayed when logging SQL.
*/
public void setShouldDisplayData(Boolean shouldDisplayData);
/**
* By default stack trace is logged for SEVERE all the time and at FINER level for WARNING or less.
* This can be turned off.
*/
public void setShouldLogExceptionStackTrace(boolean flag);
/**
* By default date is printed, this can be turned off.
*/
public void setShouldPrintDate(boolean flag);
/**
* By default the thread is logged at FINE or less level, this can be turned off.
*/
public void setShouldPrintThread(boolean flag);
/**
* By default the connection is always printed whenever available, this can be turned off.
*/
public void setShouldPrintConnection(boolean flag);
/**
* By default the Session is always printed whenever available, this can be turned off.
*/
public void setShouldPrintSession(boolean flag);
/**
* PUBLIC:
* Return the writer to which an accessor writes logged messages and SQL.
* If not set, this reference usually defaults to a writer on System.out.
* To enable logging, logMessages must be turned on in the session.
*/
public Writer getWriter();
/**
* PUBLIC:
* Set the writer to which an accessor writes logged messages and SQL.
* If not set, this reference usually defaults to a writer on System.out.
* To enable logging, logMessages() is used on the session.
*/
public void setWriter(Writer log);
/**
* PUBLIC:
* Return the log level. Used when session is not available.
* <p>
* The EclipseLink logging levels returned correspond to:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public int getLevel();
/**
* PUBLIC:
* <p>
* Return the log level as a string value.
*/
public String getLevelString();
/**
* PUBLIC:
* Return the log level; category is only needed where name space
* is available.
* <p>
* The EclipseLink logging levels returned correspond to:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
* <p>
* The EclipseLink categories for the logging name space are:<br>
* <table summary="">
* <tr><td> </td><td>{@link #CACHE}</td> <td> </td><td>= {@value #CACHE}</td></tr>
* <tr><td> </td><td>{@link #CONNECTION}</td> <td> </td><td>= {@value #CONNECTION}</td></tr>
* <tr><td> </td><td>{@link #DMS}</td> <td> </td><td>= {@value #DMS}</td></tr>
* <tr><td> </td><td>{@link #EJB}</td> <td> </td><td>= {@value #EJB}</td></tr>
* <tr><td> </td><td>{@link #EJB_OR_METADATA}</td> <td> </td><td>= {@value #EJB_OR_METADATA}</td></tr>
* <tr><td> </td><td>{@link #EVENT}</td> <td> </td><td>= {@value #EVENT}</td></tr>
* <tr><td> </td><td>{@link #DBWS}</td> <td> </td><td>= {@value #DBWS}</td></tr>
* <tr><td> </td><td>{@link #JPARS}</td> <td> </td><td>= {@value #JPARS}</td></tr>
* <tr><td> </td><td>{@link #METAMODEL}</td> <td> </td><td>= {@value #METAMODEL}</td></tr>
* <tr><td> </td><td>{@link #MOXY}</td> <td> </td><td>= {@value #MOXY}</td></tr>
* <tr><td> </td><td>{@link #PROCESSOR}</td> <td> </td><td>= {@value #PROCESSOR}</td></tr>
* <tr><td> </td><td>{@link #PROPAGATION}</td> <td> </td><td>= {@value #PROPAGATION}</td></tr>
* <tr><td> </td><td>{@link #PROPERTIES}</td> <td> </td><td>= {@value #PROPERTIES}</td></tr>
* <tr><td> </td><td>{@link #QUERY}</td> <td> </td><td>= {@value #QUERY}</td></tr>
* <tr><td> </td><td>{@link #SEQUENCING}</td> <td> </td><td>= {@value #SEQUENCING}</td></tr>
* <tr><td> </td><td>{@link #SERVER}</td> <td> </td><td>= {@value #SERVER}</td></tr>
* <tr><td> </td><td>{@link #SQL}</td> <td> </td><td>= {@value #SQL}</td></tr>
* <tr><td> </td><td>{@link #THREAD}</td> <td> </td><td>= {@value #THREAD}</td></tr>
* <tr><td> </td><td>{@link #TRANSACTION}</td> <td> </td><td>= {@value #TRANSACTION}</td></tr>
* <tr><td> </td><td>{@link #WEAVER}</td> <td> </td><td>= {@value #WEAVER}</td></tr>
* </table>
*/
public int getLevel(String category);
/**
* PUBLIC:
* Set the log level. Used when session is not available.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void setLevel(int level);
/**
* PUBLIC:
* Set the log level. Category is only needed where name space
* is available.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
* <p>
* The EclipseLink categories for the logging name space are:<br>
* <table summary="">
* <tr><td> </td><td>{@link #CACHE}</td> <td> </td><td>= {@value #CACHE}</td></tr>
* <tr><td> </td><td>{@link #CONNECTION}</td> <td> </td><td>= {@value #CONNECTION}</td></tr>
* <tr><td> </td><td>{@link #DMS}</td> <td> </td><td>= {@value #DMS}</td></tr>
* <tr><td> </td><td>{@link #EJB}</td> <td> </td><td>= {@value #EJB}</td></tr>
* <tr><td> </td><td>{@link #EJB_OR_METADATA}</td> <td> </td><td>= {@value #EJB_OR_METADATA}</td></tr>
* <tr><td> </td><td>{@link #EVENT}</td> <td> </td><td>= {@value #EVENT}</td></tr>
* <tr><td> </td><td>{@link #DBWS}</td> <td> </td><td>= {@value #DBWS}</td></tr>
* <tr><td> </td><td>{@link #JPARS}</td> <td> </td><td>= {@value #JPARS}</td></tr>
* <tr><td> </td><td>{@link #METAMODEL}</td> <td> </td><td>= {@value #METAMODEL}</td></tr>
* <tr><td> </td><td>{@link #MOXY}</td> <td> </td><td>= {@value #MOXY}</td></tr>
* <tr><td> </td><td>{@link #PROCESSOR}</td> <td> </td><td>= {@value #PROCESSOR}</td></tr>
* <tr><td> </td><td>{@link #PROPAGATION}</td> <td> </td><td>= {@value #PROPAGATION}</td></tr>
* <tr><td> </td><td>{@link #PROPERTIES}</td> <td> </td><td>= {@value #PROPERTIES}</td></tr>
* <tr><td> </td><td>{@link #QUERY}</td> <td> </td><td>= {@value #QUERY}</td></tr>
* <tr><td> </td><td>{@link #SEQUENCING}</td> <td> </td><td>= {@value #SEQUENCING}</td></tr>
* <tr><td> </td><td>{@link #SERVER}</td> <td> </td><td>= {@value #SERVER}</td></tr>
* <tr><td> </td><td>{@link #SQL}</td> <td> </td><td>= {@value #SQL}</td></tr>
* <tr><td> </td><td>{@link #THREAD}</td> <td> </td><td>= {@value #THREAD}</td></tr>
* <tr><td> </td><td>{@link #TRANSACTION}</td> <td> </td><td>= {@value #TRANSACTION}</td></tr>
* <tr><td> </td><td>{@link #WEAVER}</td> <td> </td><td>= {@value #WEAVER}</td></tr>
* </table>
*/
public void setLevel(int level, String category);
/**
* PUBLIC:
* Check if a message of the given level would actually be logged.
* Used when session is not available.
* <p>
* The EclipseLink logging levels available are:
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public boolean shouldLog(int level);
/**
* PUBLIC:
* Check if a message of the given level would actually be logged.
* Category is only needed where name space is available.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
* <p>
* The EclipseLink categories for the logging name space are:<br>
* <table summary="">
* <tr><td> </td><td>{@link #CACHE}</td> <td> </td><td>= {@value #CACHE}</td></tr>
* <tr><td> </td><td>{@link #CONNECTION}</td> <td> </td><td>= {@value #CONNECTION}</td></tr>
* <tr><td> </td><td>{@link #DMS}</td> <td> </td><td>= {@value #DMS}</td></tr>
* <tr><td> </td><td>{@link #EJB}</td> <td> </td><td>= {@value #EJB}</td></tr>
* <tr><td> </td><td>{@link #EJB_OR_METADATA}</td> <td> </td><td>= {@value #EJB_OR_METADATA}</td></tr>
* <tr><td> </td><td>{@link #EVENT}</td> <td> </td><td>= {@value #EVENT}</td></tr>
* <tr><td> </td><td>{@link #DBWS}</td> <td> </td><td>= {@value #DBWS}</td></tr>
* <tr><td> </td><td>{@link #JPARS}</td> <td> </td><td>= {@value #JPARS}</td></tr>
* <tr><td> </td><td>{@link #METAMODEL}</td> <td> </td><td>= {@value #METAMODEL}</td></tr>
* <tr><td> </td><td>{@link #MOXY}</td> <td> </td><td>= {@value #MOXY}</td></tr>
* <tr><td> </td><td>{@link #PROCESSOR}</td> <td> </td><td>= {@value #PROCESSOR}</td></tr>
* <tr><td> </td><td>{@link #PROPAGATION}</td> <td> </td><td>= {@value #PROPAGATION}</td></tr>
* <tr><td> </td><td>{@link #PROPERTIES}</td> <td> </td><td>= {@value #PROPERTIES}</td></tr>
* <tr><td> </td><td>{@link #QUERY}</td> <td> </td><td>= {@value #QUERY}</td></tr>
* <tr><td> </td><td>{@link #SEQUENCING}</td> <td> </td><td>= {@value #SEQUENCING}</td></tr>
* <tr><td> </td><td>{@link #SERVER}</td> <td> </td><td>= {@value #SERVER}</td></tr>
* <tr><td> </td><td>{@link #SQL}</td> <td> </td><td>= {@value #SQL}</td></tr>
* <tr><td> </td><td>{@link #TRANSACTION}</td> <td> </td><td>= {@value #TRANSACTION}</td></tr>
* <tr><td> </td><td>{@link #WEAVER}</td> <td> </td><td>= {@value #WEAVER}</td></tr>
* </table>
*/
public boolean shouldLog(int level, String category);
/**
* PUBLIC:
* Log a message that does not need to be translated. This method is intended for
* external use when logging messages are wanted within the EclipseLink output.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String message);
/**
* PUBLIC:
* Log a message with one parameter that needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String message, Object param);
/**
* PUBLIC:
* Log a message with one parameter that needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String category, String message, Object param);
/**
* PUBLIC:
* Log a message with two parameters that needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String message, Object param1, Object param2);
/**
* PUBLIC:
* Log a message with two parameters that needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String category, String message, Object param1, Object param2);
/**
* PUBLIC:
* Log a message with three parameters that needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String message, Object param1, Object param2, Object param3);
/**
* PUBLIC:
* Log a message with three parameters that needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String category, String message, Object param1, Object param2, Object param3);
/**
* PUBLIC:
* Log a message with four parameters that needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String message, Object param1, Object param2, Object param3, Object param4);
/**
* PUBLIC:
* Log a message with four parameters that needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String category, String message, Object param1, Object param2, Object param3, Object param4);
/**
* PUBLIC:
* This method is called when the log request is from somewhere session is not available.
* The message needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String message, Object[] arguments);
/**
* PUBLIC:
* This method is called when the log request is from somewhere session is not available.
* The message needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String category, String message, Object[] arguments);
/**
* PUBLIC:
* This method is called when the log request is from somewhere session is not available.
* shouldTranslate flag determines if the message needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String message, Object[] arguments, boolean shouldTranslate);
/**
* PUBLIC:
* This method is called when the log request is from somewhere session is not available.
* shouldTranslate flag determines if the message needs to be translated.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void log(int level, String category, String message, Object[] arguments, boolean shouldTranslate);
/**
* PUBLIC:
* This method is called when a throwable at finer level needs to be logged.
*/
public void throwing(Throwable throwable);
/**
* PUBLIC:
* This method is called when a severe level message needs to be logged.
* The message will be translated
*/
public void severe(String message);
/**
* PUBLIC:
* This method is called when a warning level message needs to be logged.
* The message will be translated
*/
public void warning(String message);
/**
* PUBLIC:
* This method is called when a info level message needs to be logged.
* The message will be translated
*/
public void info(String message);
/**
* PUBLIC:
* This method is called when a config level message needs to be logged.
* The message will be translated
*/
public void config(String message);
/**
* PUBLIC:
* This method is called when a fine level message needs to be logged.
* The message will be translated
*/
public void fine(String message);
/**
* PUBLIC:
* This method is called when a finer level message needs to be logged.
* The message will be translated
*/
public void finer(String message);
/**
* PUBLIC:
* This method is called when a finest level message needs to be logged.
* The message will be translated
*/
public void finest(String message);
/**
* PUBLIC:
* Log a {@link Throwable} with level.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void logThrowable(int level, Throwable throwable);
/**
* PUBLIC:
* Log a throwable with level.
* <p>
* The EclipseLink logging levels available are:<br>
* <table summary="">
* <tr><td>{@link #ALL}</td> <td> </td><td>= {@value #ALL}</td>
* <tr><td>{@link #FINEST}</td> <td> </td><td>= {@value #FINEST}</td>
* <tr><td>{@link #FINER}</td> <td> </td><td>= {@value #FINER}</td>
* <tr><td>{@link #FINE}</td> <td> </td><td>= {@value #FINE}</td>
* <tr><td>{@link #CONFIG}</td> <td> </td><td>= {@value #CONFIG}</td>
* <tr><td>{@link #INFO}</td> <td> </td><td>= {@value #INFO}</td>
* <tr><td>{@link #WARNING}</td><td> </td><td>= {@value #WARNING}</td>
* <tr><td>{@link #SEVERE}</td> <td> </td><td>= {@value #SEVERE}</td>
* <tr><td>{@link #OFF}</td> <td> </td><td>= {@value #OFF}</td>
* </table>
*/
public void logThrowable(int level, String category, Throwable throwable);
/**
* PUBLIC:
* Get the session that owns this SessionLog.
*/
public Session getSession();
/**
* PUBLIC:
* Set the session that owns this SessionLog.
*/
public void setSession(Session session);
/**
* PUBLIC:
* Clone the log.
*/
public Object clone();
}
|