001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.console.widgets;
018
019/**
020 * Marker for a reusable widget primitive.
021 *
022 * <p>
023 * Each concrete type owns a {@code public static final String CONTRACT_VERSION} (starting at {@code "1"}) and
024 * implements {@link #validate()} as a fail-closed bean-level check.  Serving-path call sites (for example a
025 * table emitter) must invoke {@code validate()} rather than treating it as documentation-only.
026 *
027 * <p>
028 * The REST serving path now enforces this independently of any one call site: every classpath that carries this
029 * module registers a {@code ResponseProcessor} (see
030 * {@link WidgetsMixin.WidgetValidationProcessor
031 * WidgetsMixin.WidgetValidationProcessor}) that calls {@link #validate()} on any REST response content
032 * that is a {@code Widget}, fail-closed with a 500 on failure.  That closes the gap for the two implementations
033 * that ride the wire as a JSON response body ({@code ModalDef}/{@code FormDef}) rather than being consumed by a
034 * server-side emitter that already validates on the way in; a non-REST producer (a direct {@code Json.of(...)}
035 * serialization, for example) is untouched by construction and still relies on an explicit {@code validate()} /
036 * {@code checked()} call.
037 *
038 * @since 10.0.0
039 */
040public interface Widget {
041
042   /**
043    * Fail-closed bean validation.
044    *
045    * @throws IllegalArgumentException If this widget is not well-formed.
046    */
047   void validate();
048}