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 java.util.Map;
022
023import com.nimbusds.oauth2.sdk.ParseException;
024
025
026/**
027 * Federation policy operation.
028 */
029public interface PolicyOperation {
030        
031        
032        /**
033         * Returns the name identifying the policy operation.
034         *
035         * @return The operation name.
036         */
037        OperationName getOperationName();
038        
039        
040        /**
041         * Parses a federation policy operation configuration from the
042         * specified JSON entity.
043         *
044         * @param jsonEntity The JSON entity, must represent a boolean, number,
045         *                   string, array or object. {@code null} if not
046         *                   specified.
047         *
048         * @throws ParseException On a parse exception.
049         */
050        void parseConfiguration(final Object jsonEntity) throws ParseException;
051        
052        
053        /**
054         * Returns a JSON object entry representation of the policy operation.
055         *
056         * @return The JSON object entry, with a boolean, number, string, array
057         *         or object value.
058         */
059        Map.Entry<String,Object> toJSONObjectEntry();
060        
061        
062        /**
063         * Merges a policy operation.
064         *
065         * @param other The policy to merge. Must be of the same type and not
066         *              {@code null}.
067         *
068         * @return The resulting new policy operation.
069         *
070         * @throws PolicyViolationException On a merge exception.
071         */
072        PolicyOperation merge(final PolicyOperation other) throws PolicyViolationException;
073}