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.io;
019
020import org.forgerock.http.io.Buffer;
021import org.forgerock.http.io.IO;
022import org.forgerock.openig.heap.GenericHeaplet;
023import org.forgerock.openig.heap.HeapException;
024import org.forgerock.util.Factory;
025
026/**
027 * A wrapper class around {@link IO#newTemporaryStorage} to make it usable
028 * within a heaplet environment.
029 */
030public class TemporaryStorage implements Factory<Buffer> {
031
032    private final Factory<Buffer> factory;
033
034    /**
035     * Creates a new temporary storage with a default implementation.
036     */
037    public TemporaryStorage() {
038        this(IO.newTemporaryStorage());
039    }
040
041    private TemporaryStorage(final Factory<Buffer> factory) {
042        this.factory = factory;
043    }
044
045    @Override
046    public Buffer newInstance() {
047        return factory.newInstance();
048    }
049
050    /**
051     * Creates and initializes a temporary storage object in a heap environment.
052     */
053    public static class Heaplet extends GenericHeaplet {
054        @Override
055        public Object create() throws HeapException {
056            return new TemporaryStorage(IO.newTemporaryStorage(config.get("directory").asFile(),
057                    config.get("initialLength").defaultTo(IO.DEFAULT_TMP_INIT_LENGTH).asInteger(),
058                    config.get("memoryLimit").defaultTo(IO.DEFAULT_TMP_MEMORY_LIMIT).asInteger(),
059                    config.get("fileLimit").defaultTo(IO.DEFAULT_TMP_FILE_LIMIT).asInteger()));
060        }
061    }
062}