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-2014 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 implementation
026 * provides reasonable safe defaults, to be overridden by the concrete object's heaplet.
027 */
028public class GenericHeapObject {
029
030    /** Provides methods for various logging activities. */
031    public Logger logger = new Logger(new NullLogSink(), Name.of(getClass()));
032
033    /** Allocates temporary buffers for caching streamed content during processing. */
034    public TemporaryStorage storage = new TemporaryStorage();
035}