org.lastaflute.web.callback.ActionRuntime Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lastaflute Show documentation
Show all versions of lastaflute Show documentation
Typesafe Web Framework for LeAn STArtup with DBFlute and Java8
/*
* Copyright 2014-2015 the original author or authors.
*
* Licensed 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.lastaflute.web.callback;
import java.lang.reflect.Method;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import org.dbflute.optional.OptionalThing;
import org.dbflute.util.DfTypeUtil;
import org.lastaflute.web.response.ActionResponse;
import org.lastaflute.web.response.HtmlResponse;
import org.lastaflute.web.response.JsonResponse;
import org.lastaflute.web.ruts.VirtualActionForm;
import org.lastaflute.web.ruts.config.ActionExecute;
import org.lastaflute.web.ruts.message.ActionMessages;
import org.lastaflute.web.ruts.process.RequestUrlParam;
import org.lastaflute.web.util.LaParamWrapperUtil;
/**
* @author jflute
*/
public class ActionRuntime {
// ===================================================================================
// Attribute
// =========
// -----------------------------------------------------
// Request Resource
// ----------------
protected final ActionExecute execute; // fixed meta data
protected final RequestUrlParam urlParam; // of current request
// -----------------------------------------------------
// Runtime State
// -------------
protected OptionalThing form;
protected ActionResponse actionResponse;
protected RuntimeException failureCause;
protected ActionMessages validationErrors;
protected Map displayDataMap; // lazy loaded
// ===================================================================================
// Constructor
// ===========
public ActionRuntime(ActionExecute execute, RequestUrlParam urlParam) {
this.execute = execute;
this.urlParam = urlParam;
}
// ===================================================================================
// Basic Resource
// ==============
/**
* Get the type of requested action.
* @return The type object of action, non enhanced. (NotNull)
*/
public Class getActionType() {
return execute.getActionMapping().getActionDef().getComponentClass();
}
/**
* Get the method object of action execute.
* @return The method object from execute configuration. (NotNull)
*/
public Method getExecuteMethod() {
return execute.getExecuteMethod();
}
/**
* Is the action execute for API request? (contains e.g. JSON response return type)
* @return The determination, true or false.
*/
public boolean isApiExecute() {
return execute.isApiExecute();
}
// ===================================================================================
// Action Status
// =============
// -----------------------------------------------------
// Response
// --------
/**
* Is the result of the action execute, forward to HTML template?
* @return The determination, true or false.
*/
public boolean isForwardToHtml() {
if (!isHtmlResponse()) { // e.g. exception, AJAX
return false;
}
final HtmlResponse htmlResponse = ((HtmlResponse) actionResponse);
return !htmlResponse.isRedirectTo() && isHtmlTemplateResponse(htmlResponse);
}
protected boolean isHtmlTemplateResponse(final HtmlResponse htmlResponse) {
final String routingPath = htmlResponse.getRoutingPath();
return routingPath.endsWith(".html") || routingPath.endsWith(".jsp");
}
/**
* Is the result of the action execute, redirect?
* @return The determination, true or false.
*/
public boolean isRedirectTo() {
return isHtmlResponse() && ((HtmlResponse) actionResponse).isRedirectTo();
}
/**
* Is the existing response HTML?
* @return The determination, true or false.
*/
protected boolean isHtmlResponse() {
return actionResponse != null && actionResponse instanceof HtmlResponse;
}
/**
* Is the result of the action execute, JSON?
* @return The determination, true or false.
*/
public boolean isReturnJson() {
return isJsonResponse();
}
/**
* Is the existing response JSON?
* @return The determination, true or false.
*/
protected boolean isJsonResponse() {
return actionResponse != null && actionResponse instanceof JsonResponse;
}
// -----------------------------------------------------
// Failure/Error
// -------------
/**
* Does it have exception as failure cause? (also contains validation error)
* @return The determination, true or false.
*/
public boolean hasFailureCause() {
return failureCause != null;
}
/**
* Does it have any validation errors?
* @return The determination, true or false.
*/
public boolean hasValidationError() {
return validationErrors != null && !validationErrors.isEmpty();
}
// ===================================================================================
// Display Data
// ============
public void registerData(String key, Object value) {
if (displayDataMap == null) {
displayDataMap = new LinkedHashMap(4);
}
displayDataMap.put(key, filterDisplayDataValue(value));
}
protected Object filterDisplayDataValue(Object value) {
return LaParamWrapperUtil.convert(value);
}
public void clearDisplayData() { // called by system exception dispatch for API, just in case leak
if (displayDataMap != null) {
displayDataMap.clear();
displayDataMap = null;
}
}
// ===================================================================================
// Basic Override
// ==============
@Override
public String toString() {
final StringBuilder sb = new StringBuilder();
sb.append("runtime:{").append(execute.toSimpleMethodExp());
sb.append(", urlParam=").append(urlParam);
if (actionResponse != null) {
sb.append(", response=").append(actionResponse);
}
if (failureCause != null) {
sb.append(", failure=").append(DfTypeUtil.toClassTitle(failureCause));
}
if (validationErrors != null) {
sb.append(", errors=").append(validationErrors.toPropertySet());
}
if (displayDataMap != null) {
sb.append(", display=").append(displayDataMap.keySet());
}
sb.append("}");
return sb.toString();
}
// ===================================================================================
// Accessor
// ========
// -----------------------------------------------------
// Request Resource
// ----------------
/**
* Get the definition of the requested action execute.
* @return The object that has definition info of action execute. (NotNull)
*/
public ActionExecute getActionExecute() {
return execute;
}
/**
* Get the URL parameters of the request for the action.
* @return The object that has e.g. URL parameter values. (NotNull)
*/
public RequestUrlParam getRequestUrlParam() {
return urlParam;
}
// -----------------------------------------------------
// Runtime State
// -------------
/**
* Get the action form mapped from request parameter.
* @return The optional action form. (NotNull, EmptyAllowed: when no form or before form creation)
*/
public OptionalThing getActionForm() {
return form != null ? form : OptionalThing.empty();
}
public void setActionForm(OptionalThing form) {
this.form = form;
}
/**
* Get the action response returned by action execute.
* @return The action response returned by action execute. (NullAllowed: not null only when success)
*/
public ActionResponse getActionResponse() {
return actionResponse;
}
public void setActionResponse(ActionResponse actionResponse) {
this.actionResponse = actionResponse;
}
/**
* Get the exception as failure cause thrown by action execute.
* @return The exception as failure cause. (NullAllowed: when before execute or on success)
*/
public RuntimeException getFailureCause() {
return failureCause;
}
public void setFailureCause(RuntimeException failureCause) {
this.failureCause = failureCause;
}
/**
* Get the messages as validation error.
* @return The messages as validation error. (NullAllowed: when no validation error)
*/
public ActionMessages getValidationErrors() {
return validationErrors;
}
public void setValidationErrors(ActionMessages validationErrors) {
this.validationErrors = validationErrors;
}
/**
* Get the map of display data registered by e.g. HtmlResponse, ActionCallback.
* @return The read-only map of display data. (NotNull)
*/
public Map getDisplayDataMap() {
return displayDataMap != null ? Collections.unmodifiableMap(displayDataMap) : Collections.emptyMap();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy