org.apache.juneau.rest.RestChildren Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.rest;
import static org.apache.juneau.internal.CollectionUtils.*;
import java.util.*;
import jakarta.servlet.*;
import org.apache.juneau.*;
import org.apache.juneau.cp.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.rest.annotation.*;
import org.apache.juneau.rest.util.*;
/**
* Implements the child resources of a {@link Rest}-annotated class.
*
* See Also:
*/
public class RestChildren {
//-----------------------------------------------------------------------------------------------------------------
// Static
//-----------------------------------------------------------------------------------------------------------------
/**
* Represents a null value for the {@link Rest#restChildrenClass()} annotation.
*/
@SuppressWarnings("javadoc")
public final class Void extends RestChildren {
public Void(Builder builder) throws Exception {
super(builder);
}
}
/**
* Static creator.
*
* @param beanStore The bean store to use for creating beans.
* @return A new builder for this object.
*/
public static Builder create(BeanStore beanStore) {
return new Builder(beanStore);
}
//-----------------------------------------------------------------------------------------------------------------
// Builder
//-----------------------------------------------------------------------------------------------------------------
/**
* Builder class.
*/
@FluentSetters
public static class Builder extends BeanBuilder {
final List list;
/**
* Constructor.
*
* @param beanStore The bean store to use for creating beans.
*/
protected Builder(BeanStore beanStore) {
super(RestChildren.class, beanStore);
list = list();
}
@Override /* BeanBuilder */
protected RestChildren buildDefault() {
return new RestChildren(this);
}
//-------------------------------------------------------------------------------------------------------------
// Properties
//-------------------------------------------------------------------------------------------------------------
/**
* Adds a child resource to this builder.
*
* @param value The REST context of the child resource.
* @return This object.
*/
public Builder add(RestContext value) {
list.add(value);
return this;
}
//
@Override /* GENERATED - org.apache.juneau.BeanBuilder */
public Builder impl(Object value) {
super.impl(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanBuilder */
public Builder type(Class value) {
super.type(value);
return this;
}
//
}
//-----------------------------------------------------------------------------------------------------------------
// Instance
//-----------------------------------------------------------------------------------------------------------------
private final Map children = synced(map());
/**
* Constructor.
*
* @param builder The builder containing the settings for this object.
*/
public RestChildren(Builder builder) {
for (RestContext rc : builder.list)
children.put(rc.getPath(), rc);
}
/**
* Looks through the registered children of this object and returns the best match.
*
* @param builder The HTTP call builder.
* @return The child that best matches the call, or an empty {@link Optional} if a match could not be made.
*/
public Optional findMatch(RestSession.Builder builder) {
String pi = builder.getPathInfoUndecoded();
if ((! children.isEmpty()) && pi != null && ! pi.equals("/")) {
for (RestContext rc : children.values()) {
UrlPathMatcher upp = rc.getPathMatcher();
UrlPathMatch uppm = upp.match(builder.getUrlPath());
if (uppm != null) {
return optional(RestChildMatch.create(uppm, rc));
}
}
}
return empty();
}
/**
* Returns the children in this object as a map.
*
*
* The keys are the {@link RestContext#getPath() paths} of the child contexts.
*
* @return The children as an unmodifiable map.
*/
public Map asMap() {
return unmodifiable(children);
}
//-----------------------------------------------------------------------------------------------------------------
// Lifecycle methods.
//-----------------------------------------------------------------------------------------------------------------
/**
* Called during servlet initialization on all children to invoke all {@link RestPostInit} child-last methods.
*
* @throws ServletException Error occurred.
*/
public void postInit() throws ServletException {
for (RestContext childContext : children.values())
childContext.postInit();
}
/**
* Called during servlet initialization on all children to invoke all {@link RestPostInit} child-first methods.
*
* @throws ServletException Error occurred.
*/
public void postInitChildFirst() throws ServletException {
for (RestContext childContext : children.values())
childContext.postInitChildFirst();
}
/**
* Called during servlet destruction on all children to invoke all {@link RestDestroy} and {@link Servlet#destroy()} methods.
*/
public void destroy() {
for (RestContext r : children.values()) {
r.destroy();
if (r.getResource() instanceof Servlet)
((Servlet)r.getResource()).destroy();
}
}
}