001/* 002 * nimbus-jose-jwt 003 * 004 * Copyright 2012-2021, 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.jose; 019 020import java.util.Map; 021 022/** 023 * Provides JSON serialization of the JOSE Object. 024 * 025 * @author Alexander Martynov 026 * @version 2021-08-17 027 */ 028public interface JSONSerializable { 029 030 /** 031 * Returns a General JSON object representation of the JOSE Object. 032 * 033 * @throws IllegalStateException If the JOSE object is not in a state 034 * that permits serialisation. 035 * @return The JSON object. 036 */ 037 Map<String, Object> toGeneralJSONObject(); 038 039 /** 040 * Returns a Flattened JSON object representation of the JOSE Object. 041 * 042 * @throws IllegalStateException If the JOSE object is not in a state 043 * that permits serialisation. 044 * @return The JSON object. 045 */ 046 Map<String, Object> toFlattenedJSONObject(); 047}