org.rootservices.otter.gateway.Configure Maven / Gradle / Ivy

Go to download
package org.rootservices.otter.gateway;


import org.rootservices.otter.controller.entity.DefaultSession;
import org.rootservices.otter.controller.entity.DefaultUser;
import org.rootservices.otter.gateway.entity.Group;
import org.rootservices.otter.gateway.entity.rest.RestGroup;
import org.rootservices.otter.gateway.entity.Shape;

import java.util.List;

/**
 * Interface that must be implemented to configure a Otter application.
 *
 */
public interface Configure {
    /**
     * Returns a shape instance which instructs otter what to use for the csrf sign keys, session encrption keys,
     * rotation keys, and async i/o chuck sizes.
     *
     * @return an instance of a Shape
     */
    Shape shape();

    /**
     * Returns a list of Groups which is used to share betweens, Session, and User amongst Routes.
     *
     * @return a List of Groups
     */
    List> groups();

    /**
     * Returns a list of RestGroup which is used to share RestBetweens and User amongst RestRoutes.
     *
     * @return a List of RestGroup
     */
    List> restGroups();

    /**
     * Add Routes and RestRoutes to the gateway here.
     *
     * @param gateway An instance of the gateway.
     */
    void routes(Gateway gateway);
}