org.glassfish.jersey.server.model.ComponentModelValidator Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2013 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
* http://glassfish.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.
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* http://www.opensource.org/licenses/cddl1.php
* See the License for the specific language governing
* permissions and limitations under the License.
*/
package org.glassfish.jersey.server.model;
import java.util.List;
import org.glassfish.jersey.internal.Errors;
import org.glassfish.jersey.message.MessageBodyWorkers;
import org.glassfish.jersey.server.model.internal.ModelErrors;
import org.glassfish.hk2.api.ServiceLocator;
import com.google.common.collect.Lists;
/**
* A resource model validator that checks the given resource model.
*
* This base resource model validator class implements the visitor pattern to
* traverse through all the {@link ResourceModelComponent resource model components}
* to check validity of a resource model.
*
* This validator maintains a list of all the {@link ResourceModelIssue issues}
* found in the model. That way all the resource model components can be validated
* in a single call to the {@link #validate(ResourceModelComponent) validate(...)}
* method and collect all the validation issues from the model.
*
* To check a single resource class, the the {@link Resource}
* {@code builder(...)} can be used to create a resource model.
*
* {@link ComponentModelValidator#validate(ResourceModelComponent)}
* method then populates the issue list, which could be then obtained by the
* {@link ComponentModelValidator#getIssueList()}. Unless the list is explicitly cleared,
* a subsequent calls to the validate method will add new items to the list,
* so that it can be used to build the issue list for more than one resource. To clear the
* list, the {@link ComponentModelValidator#cleanIssueList()} method should be called.
*
*
* @author Jakub Podlesak (jakub.podlesak at oracle.com)
* @author Marek Potociar (marek.potociar at oracle.com)
*/
public final class ComponentModelValidator {
private final List issueList = Lists.newLinkedList();
private final ServiceLocator locator;
public ComponentModelValidator(ServiceLocator locator) {
this.locator = locator;
validators = Lists.newArrayList();
validators.add(new ResourceValidator());
validators.add(new RuntimeResourceModelValidator(locator.getService(MessageBodyWorkers.class)));
validators.add(new ResourceMethodValidator(locator));
validators.add(new InvocableValidator());
}
private final List validators;
/**
* Returns a list of issues found after
* {@link #validate(org.glassfish.jersey.server.model.ResourceModelComponent)}
* method has been invoked.
*
* @return a non-null list of issues.
*/
public List getIssueList() {
return issueList;
}
/**
* Convenience method to see if there were fatal issues found.
*
* @return {@code true} if there are any fatal issues present in the current
* issue list.
*/
public boolean fatalIssuesFound() {
for (ResourceModelIssue issue : getIssueList()) {
if (issue.isFatal()) {
return true;
}
}
return false;
}
/**
* Removes all issues from the current issue list. The method could be used
* to re-use the same {@link ComponentModelValidator} for another resource model.
*/
public void cleanIssueList() {
issueList.clear();
}
/**
* The validate method validates a component and adds possible
* issues found to it's list. The list of issues could be then retrieved
* via getIssueList method.
*
* @param component resource model component.
*/
public void validate(final ResourceModelComponent component) {
Errors.process(new Runnable() {
@Override
public void run() {
Errors.mark();
validateWithErrors(component);
issueList.addAll(ModelErrors.getErrorsAsResourceModelIssues(true));
Errors.unmark();
}
});
}
private void validateWithErrors(final ResourceModelComponent component) {
for (ResourceModelVisitor validator : validators) {
component.accept(validator);
}
final List componentList = component.getComponents();
if (null != componentList) {
for (ResourceModelComponent subComponent : componentList) {
validateWithErrors(subComponent);
}
}
}
}