com.unboundid.scim2.common.annotations.Schema Maven / Gradle / Ivy
/*
* Copyright 2015-2020 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.scim2.common.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Class level annotation indicating the schema of a SCIM object.
*/
@Target(value = ElementType.TYPE)
@Retention(value = RetentionPolicy.RUNTIME)
public @interface Schema
{
/**
* The id for the object. This is the complete URN.
*
* @return The object's id as a URN.
*/
String id() default "urn:pingidentity:scim:api:messages:2.0";
/**
* The description for the object.
*
* @return The object's description.
*/
String description();
/**
* The name for the object. This is a human readable
* name.
*
* @return The object's human-readable name.
*/
String name();
}