001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.json;
014
015import java.io.IOException;
016
017import org.apache.juneau.*;
018import org.apache.juneau.jsonschema.*;
019import org.apache.juneau.serializer.*;
020
021/**
022 * Session object that lives for the duration of a single use of {@link JsonSchemaSerializer}.
023 *
024 * <p>
025 * This class is NOT thread safe.
026 * It is typically discarded after one-time use although it can be reused within the same thread.
027 */
028public class JsonSchemaSerializerSession extends JsonSerializerSession {
029
030   private final JsonSchemaGeneratorSession genSession;
031   private final JsonSchemaSerializer ctx;
032
033   /**
034    * Create a new session using properties specified in the context.
035    *
036    * @param ctx
037    *    The context creating this session object.
038    *    The context contains all the configuration settings for this object.
039    * @param args
040    *    Runtime arguments.
041    *    These specify session-level information such as locale and URI context.
042    *    It also include session-level properties that override the properties defined on the bean and
043    *    serializer contexts.
044    */
045   protected JsonSchemaSerializerSession(JsonSchemaSerializer ctx, SerializerSessionArgs args) {
046      super(ctx, args);
047      genSession = ctx.getGenerator().createSession(args);
048      this.ctx = ctx;
049   }
050
051   @Override /* SerializerSession */
052   protected void doSerialize(SerializerPipe out, Object o) throws IOException, SerializeException {
053      try {
054         super.doSerialize(out, genSession.getSchema(o));
055      } catch (BeanRecursionException e) {
056         throw new SerializeException(e);
057      }
058   }
059
060   //-----------------------------------------------------------------------------------------------------------------
061   // Extended metadata
062   //-----------------------------------------------------------------------------------------------------------------
063
064   /**
065    * Returns the language-specific metadata on the specified class.
066    *
067    * @param cm The class to return the metadata on.
068    * @return The metadata.
069    */
070   protected JsonSchemaClassMeta getJsonSchemaClassMeta(ClassMeta<?> cm) {
071      return ctx.getJsonSchemaClassMeta(cm);
072   }
073
074   /**
075    * Returns the language-specific metadata on the specified bean property.
076    *
077    * @param bpm The bean property to return the metadata on.
078    * @return The metadata.
079    */
080   protected JsonSchemaBeanPropertyMeta getJsonSchemaBeanPropertyMeta(BeanPropertyMeta bpm) {
081      return ctx.getJsonSchemaBeanPropertyMeta(bpm);
082   }
083
084   //-----------------------------------------------------------------------------------------------------------------
085   // Other methods
086   //-----------------------------------------------------------------------------------------------------------------
087
088   @Override /* Session */
089   public ObjectMap toMap() {
090      return super.toMap()
091         .append("JsonSchemaSerializerSession", new DefaultFilteringObjectMap()
092      );
093   }
094}