io.gravitee.am.gateway.policy.Policy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gravitee-am-gateway-policy Show documentation

There is a newer version: 4.6.0-alpha.2

Show newest version

/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * 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 io.gravitee.am.gateway.policy;

import java.util.Map;

/**
 * @author Titouan COMPIEGNE (titouan.compiegne at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface Policy {

    String id();

    Map metadata();

    String condition();

    default void setMetadata(Map metadata) {};

    default void execute(Object ... args) throws PolicyException {}

    default boolean isRunnable() { return true; }

    void activate() throws Exception;

    void deactivate() throws Exception;
}