de.javakaffee.web.msm.TranscoderFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of memcached-session-manager Show documentation

The msm core, provides java serialization strategy.

There is a newer version: 2.3.2

Show newest version

/*
 * Copyright 2009 Martin Grotzke
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package de.javakaffee.web.msm;

import org.apache.catalina.Manager;

import de.javakaffee.web.msm.MemcachedSessionService.SessionManager;

/**
 * This factory is used to create a {@link net.spy.memcached.transcoders.Transcoder}
 * to serialize/deserialize sessions to/from memcached. Implementations need to provide
 * a default/no-args constructor so that an instance can be created via {@link Class#newInstance()}.
 *
 * @author Martin Grotzke
 * @version $Id$
 */
public interface TranscoderFactory {

    /**
     * Creates a new {@link SessionAttributesTranscoder} with the given manager.
     *
     * @param manager
     *            the manager that needs to be set on deserialized sessions.
     * @return an implementation of {@link SessionAttributesTranscoder}.
     */
    SessionAttributesTranscoder createTranscoder( SessionManager manager );

    /**
     * Specifies, if iterating over collection elements shall be done on a copy
     * of the collection or on the collection itself.
     * 
     * This will be called before {@link #createTranscoder(Manager)}, so that
     * you can use this property in {@link #createTranscoder(Manager)}.
     * 
     *
     * @param copyCollectionsForSerialization
     *            the boolean value.
     */
    void setCopyCollectionsForSerialization( boolean copyCollectionsForSerialization );

    /**
     * An optional list of custom converter class names.
     * 
     * This will be called before {@link #createTranscoder(Manager)}, so that
     * you can use this property in {@link #createTranscoder(Manager)}.
     * 
     * @param customConverterClassNames a list of class names or null.
     */
    void setCustomConverterClassNames( String[] customConverterClassNames );

}