73db2ddb960cafd7ffb6daf89eb697910d36c56dJames Phillpotts/*
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The contents of this file are subject to the terms
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * of the Common Development and Distribution License
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * (the License). You may not use this file except in
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * compliance with the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * You can obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * opensso/legal/CDDLv1.0.txt
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * See the License for the specific language governing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * permission and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * When distributing Covered Code, include this CDDL
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Header Notice in each file and include the License file
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * at opensso/legal/CDDLv1.0.txt.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * If applicable, add the following below the CDDL Header,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * with the fields enclosed by brackets [] replaced by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * your own identifying information:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * $Id: LogMessageProvider.java,v 1.4 2008/06/25 05:43:37 qcheng Exp $
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
73db2ddb960cafd7ffb6daf89eb697910d36c56dJames Phillpotts * Portions Copyrighted 2011-2015 ForgeRock AS.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterpackage com.sun.identity.log.messageid;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport com.sun.identity.log.LogRecord;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterimport java.util.List;
73db2ddb960cafd7ffb6daf89eb697910d36c56dJames Phillpottsimport java.util.Map;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster/**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This interface defines a methods for a log message provider.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterpublic interface LogMessageProvider {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns all message IDs.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return all message IDs.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster List getAllMessageIDs();
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster
73db2ddb960cafd7ffb6daf89eb697910d36c56dJames Phillpotts /**
73db2ddb960cafd7ffb6daf89eb697910d36c56dJames Phillpotts * Returns a map of message names to IDs
73db2ddb960cafd7ffb6daf89eb697910d36c56dJames Phillpotts */
73db2ddb960cafd7ffb6daf89eb697910d36c56dJames Phillpotts Map<String, LogMessageID> getAllHashMessageIDs();
73db2ddb960cafd7ffb6daf89eb697910d36c56dJames Phillpotts
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster /**
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Creates Log Record.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster *
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param messageIDName Name of Message ID.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param dataInfo Array of dataInfo.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param ssoToken Single sign on token which will be used to fill in
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * details like client IP address into the log record.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster */
73db2ddb960cafd7ffb6daf89eb697910d36c56dJames Phillpotts LogRecord createLogRecord(String messageIDName, String[] dataInfo, Object ssoToken);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster}