org.qi4j.cache.memcache.MemcacheConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.qi4j.extension.cache-memcache Show documentation
The newest version!
/*
 * Copyright 2014 Paul Merlin.
 *
 * 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 org.qi4j.cache.memcache;

import org.qi4j.api.common.Optional;
import org.qi4j.api.configuration.Configuration;
import org.qi4j.api.property.Property;

/**
 * Memcache CachePool Configuration.
 */
// START SNIPPET: config
public interface MemcacheConfiguration
    extends Configuration
{
    /**
     * Cached items expiration in seconds.
     * Defaulted to 3600 seconds, one hour.
     * @return Cached items expiration configuration property
     */
    @Optional
    Property expiration();

    /**
     * Memcached server addresses space separated.
     * Eg. {@literal "server1:11211 server2:11211"}.
     * Defaulted to {@literal "127.0.0.1:11211"}.
     * @return Memcached server addresses configuration property
     */
    @Optional
    Property addresses();

    /**
     * Memcache Protocol.
     * Can be {@literal text} or {@literal binary}
     * Defaulted to {@literal text}.
     * @return Memcache Protocol configuration property
     */
    @Optional
    Property protocol();

    /**
     * Username.
     * Authentication happens only if set.
     * @return Username configuration property
     */
    @Optional
    Property username();

    /**
     * Password.
     * @return Password configuration property
     */
    @Optional
    Property password();

    /**
     * SASL authentication mechanism.
     * Defaulted to PLAIN.
     * @return Authentication mechanism configuration property
     */
    @Optional
    Property authMechanism();
}
// END SNIPPET: config