001/*
002 * oauth2-oidc-sdk
003 *
004 * Copyright 2012-2016, Connect2id Ltd and contributors.
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
007 * this file except in compliance with the License. You may obtain a copy of the
008 * License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software distributed
013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
015 * specific language governing permissions and limitations under the License.
016 */
017
018package com.nimbusds.openid.connect.sdk.federation.policy.language;
019
020
021import com.nimbusds.oauth2.sdk.ParseException;
022
023
024/**
025 * Federation policy operation.
026 */
027public interface PolicyOperation {
028        
029        
030        /**
031         * Returns the name identifying the policy operation.
032         *
033         * @return The operation name.
034         */
035        OperationName getOperationName();
036        
037        
038        /**
039         * Parses a federation policy operation configuration from the
040         * specified JSON entity.
041         *
042         * @param jsonEntity The JSON entity, must represent a boolean, number,
043         *                   string, array or object. {@code null} if not
044         *                   specified.
045         *
046         * @throws ParseException On a parse exception.
047         */
048        void parseConfiguration(final Object jsonEntity) throws ParseException;
049        
050        
051        /**
052         * Merges a policy operation.
053         *
054         * @param other The policy to merge. Must be of the same type and not
055         *              {@code null}.
056         *
057         * @return The resulting new policy operation.
058         *
059         * @throws PolicyViolationException On a merge exception.
060         */
061        PolicyOperation merge(final PolicyOperation other) throws PolicyViolationException;
062}