001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2010-2011 ApexIdentity Inc.
015 * Portions Copyright 2011-2015 ForgeRock AS.
016 */
017
018package org.forgerock.openig.heap;
019
020import org.forgerock.openig.io.TemporaryStorage;
021import org.forgerock.openig.log.Logger;
022import org.forgerock.openig.log.NullLogSink;
023
024/**
025 * A generic base class for heap objects with handy injected heap objects. This
026 * implementation provides reasonable safe defaults, to be overridden by the
027 * concrete object's heaplet.
028 */
029public class GenericHeapObject {
030
031    /** Provides methods for various logging activities. */
032    protected Logger logger = new Logger(new NullLogSink(), Name.of(getClass()));
033
034    /**
035     * Allocates temporary buffers for caching streamed content during
036     * processing.
037     */
038    protected TemporaryStorage storage = new TemporaryStorage();
039
040    /**
041     * Return the logger.
042     * @return the logger
043     */
044    public Logger getLogger() {
045        return logger;
046    }
047
048    /**
049     * Sets the logger.
050     * @param logger the logger to set.
051     */
052    public void setLogger(Logger logger) {
053        this.logger = logger;
054    }
055
056    /**
057     * Returns the storage.
058     * @return the storage
059     */
060    public TemporaryStorage getStorage() {
061        return storage;
062    }
063
064    /**
065     * Sets the storage.
066     * @param storage the storage to set.
067     */
068    public void setStorage(TemporaryStorage storage) {
069        this.storage = storage;
070    }
071}