org.glassfish.admin.rest.results.OptionsResult Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2019-2020] Payara Foundation and/or affiliates
package org.glassfish.admin.rest.results;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import org.glassfish.admin.rest.provider.MethodMetaData;
/**
* Response information object. Returned on call to OPTIONS method.
* Information used by provider to generate the appropriate output.
*
* @author Rajeshwar Patil
*/
public class OptionsResult extends Result {
private final Map metaData;
/**
* Default Constructor
*/
public OptionsResult() {
this(null);
}
public OptionsResult(String name) {
super(name);
metaData = new HashMap<>();
}
/**
* Returns meta-data object for the given method
*/
public MethodMetaData getMethodMetaData(String method) {
return metaData.get(method);
}
/**
* Adds meta-data object for the given method
*/
public MethodMetaData putMethodMetaData(String method, MethodMetaData methodMetaData) {
return metaData.put(method, methodMetaData);
}
/**
* Returns no of method meta-data available.
* Should be equal to the number of methods on resource.
*/
public int size() {
return metaData.size();
}
/**
* Returns set of method names for which meta-data is available.
*/
public Set methods() {
return metaData.keySet();
}
}