com.manorrock.oyena.lifecycle.rest.RestLifecycle Maven / Gradle / Ivy
/*
* Copyright (c) 2002-2023 Manorrock.com. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.manorrock.oyena.lifecycle.rest;
import jakarta.enterprise.context.ApplicationScoped;
import jakarta.faces.FacesException;
import jakarta.faces.context.ExternalContext;
import jakarta.faces.context.FacesContext;
import jakarta.faces.event.PhaseListener;
import jakarta.faces.lifecycle.Lifecycle;
import jakarta.inject.Inject;
import jakarta.inject.Named;
import java.io.IOException;
/**
* The REST lifecycle.
*
* @author Manfred Riem ([email protected])
*/
@ApplicationScoped
@Named("com.manorrock.oyena.lifecycle.rest.RestLifecycle")
public class RestLifecycle extends Lifecycle {
/**
* Stores the REST mapping matcher.
*/
@Inject
private RestMappingMatcher restMappingMatcher;
/**
* Stores the REST method executor.
*/
@Inject
private RestMethodExecutor restMethodExecutor;
/**
* Stores the REST response matcher.
*/
@Inject
private RestResponseMatcher restResponseMatcher;
/**
* Add a phase listener.
*
*
* This is ignored by the REST lifecycle.
*
*
* @param phaseListener the phase listener.
*/
@Override
public void addPhaseListener(PhaseListener phaseListener) {
// adding phase listeners is ignored.
}
/**
* Perform the execute part of lifecycle.
*
* @param facesContext the Faces context.
* @throws FacesException when a serious error occurs.
*/
@Override
public void execute(FacesContext facesContext) throws FacesException {
RestMappingMatch match = restMappingMatcher.match(facesContext);
if (match != null) {
Object result = restMethodExecutor.execute(facesContext, match);
facesContext.getAttributes().put(
RestLifecycle.class.getPackage().getName() + ".RestResult", result);
} else {
try {
facesContext.getExternalContext().responseSendError(404, "Unable to match request");
facesContext.responseComplete();
} catch (IOException ioe) {
throw new FacesException(ioe);
}
}
}
/**
* Get the phase listeners.
*
*
* As phase listeners are ignored by the REST life-cycle this will always
* return a zero length array.
*
*
* @return the empty array of phase listeners.
*/
@Override
public PhaseListener[] getPhaseListeners() {
return new PhaseListener[0];
}
/**
* Remove a phase listener.
*
*
* This is ignored by the REST lifecycle.
*
*
* @param phaseListener the phase listener.
*/
@Override
public void removePhaseListener(PhaseListener phaseListener) {
// removing phase listeners is ignored.
}
/**
* Perform the render part of the REST lifecycle.
*
* @param facesContext the Faces context.
* @throws FacesException when a serious error occurs.
*/
@Override
public void render(FacesContext facesContext) throws FacesException {
if (!facesContext.getResponseComplete()) {
ExternalContext externalContext = facesContext.getExternalContext();
String responseContentType = externalContext.getResponseContentType();
if (responseContentType == null) {
externalContext.setResponseContentType("application/json");
responseContentType = "application/json";
}
restResponseMatcher.getResponseWriter(responseContentType).writeResponse(facesContext);
}
}
}