com.tangosol.application.Context Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coherence Show documentation
Oracle Coherence Community Edition
There is a newer version: 24.09
/*
 * Copyright (c) 2000, 2023, Oracle and/or its affiliates.
 *
 * Licensed under the Universal Permissive License v 1.0 as shown at
 * https://oss.oracle.com/licenses/upl.
 */

package com.tangosol.application;

import com.oracle.coherence.common.base.Classes;
import com.tangosol.io.NamedSerializerFactory;
import com.tangosol.io.Serializer;
import com.tangosol.net.CacheFactoryBuilder;
import com.tangosol.net.Coherence;
import com.tangosol.net.ConfigurableCacheFactory;
import com.tangosol.net.ServiceMonitor;

/**
 * Context represents various aspects of Coherence infrastructure that could be
 * accessed by application code working in the context of the {@link ContainerAdapter}.
 *
 * @author cf 2011.07.01
 * @since Coherence 12.1.2
 */
public interface Context
    {
    /**
     * Return the corresponding {@link ConfigurableCacheFactory}. This method
     * will return the same reference as a call to
     *      *    ctx.getExtendedContext().getCacheFactoryBuilder().
     *      getConfigurableCacheFactory(ctx.getClassLoader());
     * 
     *
     * @return the {@link ConfigurableCacheFactory}
     */
    public ConfigurableCacheFactory getConfigurableCacheFactory();

    /**
     * Return the {@link CacheFactoryBuilder} in use.
     *
     * @return the {@link CacheFactoryBuilder}
     */
    public CacheFactoryBuilder getCacheFactoryBuilder();

    /**
     * Return the {@link ClassLoader} in use.
     *
     * @return the {@link ClassLoader}
     */
    public ClassLoader getClassLoader();

    /**
     * Return the name of the application.
     *
     * @return the name of the application
     */
    public String getApplicationName();

    /**
     * Return the keep-alive facility for the application services.
     *
     * @return the {@link ServiceMonitor}
     */
    public ServiceMonitor getServiceMonitor();

    /**
     * Return the POF configuration URI.
     * 
     * For advanced use cases, the resource identified by this URI can be found
     * by calling:
     * 
     *    ctx.getExtendedContext().getClassLoader().getResource(ctx.getPofConfigUri());
     * 
     *
     * @return the POF configuration URI
     */
    public String getPofConfigURI();

    /**
     * Return the cache configuration URI.
     *
     * @return the cache configuration URI
     */
    public String getCacheConfigURI();

    /**
     * Return the {@link ContainerContext} associated with the ContainerAdapter.
     *
     * @return the {@link ContainerContext} instance or null
     */
    public ContainerContext getContainerContext();

    /**
     * Returns the default scope name to use.
     *
     * @return the default scope name to use
     */
    default String getDefaultScope()
        {
        return Coherence.DEFAULT_SCOPE;
        }

    /**
     * Produces instances of a named {@link Serializer}.
     *
     * @param sName   the name of the serializer
     *
     * @return an instance of a named {@link Serializer}
     *
     * @throws NullPointerException     if the name parameter is null
     * @throws IllegalArgumentException if no serializer is discoverable with the specified name
     */
    default Serializer getNamedSerializer(String sName)
        {
        return NamedSerializerFactory.DEFAULT.getNamedSerializer(sName, Classes.getContextClassLoader());
        }

    /**
      * @deprecated as useless, left for backward compatibility only
      *
      * @return the {@link ExtendedContext}
      */
    public ExtendedContext getExtendedContext();

    // ----- inner interface ExtendedContext --------------------------------

    /**
     * The {@link ExtendedContext} contains parameters that may be used for
     * advanced creation and management of {@link ConfigurableCacheFactory} instances.
     *
     * @author cf 2011.07.01
     *
     * @deprecated as of 12.2.1, left only for backward compatibility
     */
    public interface ExtendedContext
            extends Context
        {
        }
    }