Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WW-3714 Deprecate and repackage common APIs part 2.5 #1087

Merged
merged 2 commits into from
Oct 22, 2024
Merged

WW-3714 Deprecate and repackage common APIs part 2.5 #1087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
36a890b
WW-3714 Add factory support for new Interceptor, Result interfaces
kusalk Oct 17, 2024
b622e5d
WW-3714 Ensure ReflectionExceptionHandler, WithLazyParams, ParamNameA…
kusalk Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions core/src/main/java/com/opensymphony/xwork2/DefaultActionInvocation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,9 @@ public String invoke() throws Exception {
Interceptor interceptor = interceptorMapping.getInterceptor();
if (interceptor instanceof WithLazyParams) {
interceptor = lazyParamInjector.injectParams(interceptor, interceptorMapping.getParams(), invocationContext);
} else if (interceptor instanceof Interceptor.LegacyAdapter && ((Interceptor.LegacyAdapter) interceptor).getAdaptee() instanceof WithLazyParams) {
org.apache.struts2.interceptor.Interceptor adaptee = ((Interceptor.LegacyAdapter) interceptor).getAdaptee();
lazyParamInjector.injectParams(adaptee, interceptorMapping.getParams(), invocationContext);
}
if (interceptor instanceof ConditionalInterceptor) {
resultCode = executeConditional((ConditionalInterceptor) interceptor);
Expand Down
13 changes: 9 additions & 4 deletions core/src/main/java/com/opensymphony/xwork2/factory/DefaultInterceptorFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,18 @@ public Interceptor buildInterceptor(InterceptorConfig interceptorConfig, Map<Str
reflectionProvider.setProperties(params, o);
}

Interceptor interceptor = null;
if (o instanceof Interceptor) {
Interceptor interceptor = (Interceptor) o;
interceptor.init();
return interceptor;
interceptor = (Interceptor) o;
} else if (o instanceof org.apache.struts2.interceptor.Interceptor) {
interceptor = Interceptor.adapt((org.apache.struts2.interceptor.Interceptor) o);
}

throw new ConfigurationException("Class [" + interceptorClassName + "] does not implement Interceptor", interceptorConfig);
if (interceptor == null) {
throw new ConfigurationException("Class [" + interceptorClassName + "] does not implement Interceptor", interceptorConfig);
}
interceptor.init();
return interceptor;
} catch (InstantiationException e) {
cause = e;
message = "Unable to instantiate an instance of Interceptor class [" + interceptorClassName + "].";
Expand Down
19 changes: 15 additions & 4 deletions core/src/main/java/com/opensymphony/xwork2/factory/DefaultResultFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

import com.opensymphony.xwork2.ObjectFactory;
import com.opensymphony.xwork2.Result;
import com.opensymphony.xwork2.config.ConfigurationException;
import com.opensymphony.xwork2.config.entities.ResultConfig;
import com.opensymphony.xwork2.inject.Inject;
import com.opensymphony.xwork2.util.reflection.ReflectionException;
Expand Down Expand Up @@ -51,19 +52,29 @@ public Result buildResult(ResultConfig resultConfig, Map<String, Object> extraCo
Result result = null;

if (resultClassName != null) {
result = (Result) objectFactory.buildBean(resultClassName, extraContext);
Object o = objectFactory.buildBean(resultClassName, extraContext);

Map<String, String> params = resultConfig.getParams();
if (params != null) {
for (Map.Entry<String, String> paramEntry : params.entrySet()) {
try {
reflectionProvider.setProperty(paramEntry.getKey(), paramEntry.getValue(), result, extraContext, true);
reflectionProvider.setProperty(paramEntry.getKey(), paramEntry.getValue(), o, extraContext, true);
} catch (ReflectionException ex) {
if (result instanceof ReflectionExceptionHandler) {
((ReflectionExceptionHandler) result).handle(ex);
if (o instanceof ReflectionExceptionHandler) {
((ReflectionExceptionHandler) o).handle(ex);
}
}
}
}

if (o instanceof Result) {
result = (Result) o;
} else if (o instanceof org.apache.struts2.Result) {
result = Result.adapt((org.apache.struts2.Result) o);
}
if (result == null) {
throw new ConfigurationException("Class [" + resultClassName + "] does not implement Result", resultConfig);
}
}

return result;
Expand Down
23 changes: 23 additions & 0 deletions core/src/main/java/com/opensymphony/xwork2/interceptor/ConditionalInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,32 @@
@Deprecated
public interface ConditionalInterceptor extends org.apache.struts2.interceptor.ConditionalInterceptor, Interceptor {

@Override
default boolean shouldIntercept(org.apache.struts2.ActionInvocation invocation) {
return shouldIntercept(ActionInvocation.adapt(invocation));
}

boolean shouldIntercept(ActionInvocation invocation);

static ConditionalInterceptor adapt(org.apache.struts2.interceptor.ConditionalInterceptor actualInterceptor) {
if (actualInterceptor instanceof ConditionalInterceptor) {
return (ConditionalInterceptor) actualInterceptor;
}
return actualInterceptor != null ? new LegacyAdapter(actualInterceptor) : null;
}

class LegacyAdapter extends Interceptor.LegacyAdapter implements ConditionalInterceptor {

private final org.apache.struts2.interceptor.ConditionalInterceptor adaptee;

private LegacyAdapter(org.apache.struts2.interceptor.ConditionalInterceptor adaptee) {
super(adaptee);
this.adaptee = adaptee;
}

@Override
public boolean shouldIntercept(ActionInvocation invocation) {
return adaptee.shouldIntercept(invocation);
}
}
}
38 changes: 38 additions & 0 deletions core/src/main/java/com/opensymphony/xwork2/interceptor/Interceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,42 @@ default String intercept(org.apache.struts2.ActionInvocation invocation) throws
}

String intercept(ActionInvocation invocation) throws Exception;

static Interceptor adapt(org.apache.struts2.interceptor.Interceptor actualInterceptor) {
if (actualInterceptor instanceof org.apache.struts2.interceptor.ConditionalInterceptor) {
return ConditionalInterceptor.adapt((org.apache.struts2.interceptor.ConditionalInterceptor) actualInterceptor);
}
if (actualInterceptor instanceof Interceptor) {
return (Interceptor) actualInterceptor;
}
return actualInterceptor != null ? new LegacyAdapter(actualInterceptor) : null;
}

class LegacyAdapter implements Interceptor {

private final org.apache.struts2.interceptor.Interceptor adaptee;

protected LegacyAdapter(org.apache.struts2.interceptor.Interceptor adaptee) {
this.adaptee = adaptee;
}

public org.apache.struts2.interceptor.Interceptor getAdaptee() {
return adaptee;
}

@Override
public String intercept(ActionInvocation invocation) throws Exception {
return adaptee.intercept(invocation);
}

@Override
public void destroy() {
adaptee.destroy();
}

@Override
public void init() {
adaptee.init();
}
}
}
5 changes: 4 additions & 1 deletion core/src/main/java/com/opensymphony/xwork2/interceptor/WithLazyParams.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,14 @@ public void setOgnlUtil(OgnlUtil ognlUtil) {
}

public Interceptor injectParams(Interceptor interceptor, Map<String, String> params, ActionContext invocationContext) {
return (Interceptor) injectParams((org.apache.struts2.interceptor.Interceptor) interceptor, params, invocationContext);
}

public org.apache.struts2.interceptor.Interceptor injectParams(org.apache.struts2.interceptor.Interceptor interceptor, Map<String, String> params, ActionContext invocationContext) {
for (Map.Entry<String, String> entry : params.entrySet()) {
Object paramValue = textParser.evaluate(new char[]{ '$' }, entry.getValue(), valueEvaluator, TextParser.DEFAULT_LOOP_COUNT);
ognlUtil.setProperty(entry.getKey(), paramValue, interceptor, invocationContext.getContextMap());
}

return interceptor;
}
}
Expand Down
40 changes: 36 additions & 4 deletions core/src/main/java/org/apache/struts2/factory/StrutsResultFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,14 @@

import com.opensymphony.xwork2.ObjectFactory;
import com.opensymphony.xwork2.Result;
import com.opensymphony.xwork2.config.ConfigurationException;
import com.opensymphony.xwork2.config.entities.ResultConfig;
import com.opensymphony.xwork2.factory.ResultFactory;
import com.opensymphony.xwork2.inject.Inject;
import com.opensymphony.xwork2.result.ParamNameAwareResult;
import com.opensymphony.xwork2.util.reflection.ReflectionException;
import com.opensymphony.xwork2.util.reflection.ReflectionExceptionHandler;
import com.opensymphony.xwork2.util.reflection.ReflectionProvider;
import com.opensymphony.xwork2.result.ParamNameAwareResult;

import java.util.Map;

Expand All @@ -53,16 +54,36 @@ public Result buildResult(ResultConfig resultConfig, Map<String, Object> extraCo
Result result = null;

if (resultClassName != null) {
result = (Result) objectFactory.buildBean(resultClassName, extraContext);
Object o = objectFactory.buildBean(resultClassName, extraContext);
Map<String, String> params = resultConfig.getParams();
if (params != null) {
setParameters(extraContext, result, params);
setParameters(extraContext, o, params);
}
if (o instanceof Result) {
result = (Result) o;
} else if (o instanceof org.apache.struts2.Result) {
result = Result.adapt((org.apache.struts2.Result) o);
}
if (result == null) {
throw new ConfigurationException("Class [" + resultClassName + "] does not implement Result", resultConfig);
}
}
return result;
}

protected void setParameters(Map<String, Object> extraContext, Result result, Map<String, String> params) {
setParametersHelper(extraContext, result, params);
}

protected void setParameters(Map<String, Object> extraContext, Object result, Map<String, String> params) {
if (result instanceof Result) {
setParameters(extraContext, (Result) result, params);
} else {
setParametersHelper(extraContext, result, params);
}
}

private void setParametersHelper(Map<String, Object> extraContext, Object result, Map<String, String> params) {
for (Map.Entry<String, String> paramEntry : params.entrySet()) {
try {
String name = paramEntry.getKey();
Expand All @@ -77,6 +98,18 @@ protected void setParameters(Map<String, Object> extraContext, Result result, Ma
}

protected void setParameter(Result result, String name, String value, Map<String, Object> extraContext) {
setParameterHelper(result, name, value, extraContext);
}

private void setParameter(Object result, String name, String value, Map<String, Object> extraContext) {
if (result instanceof Result) {
setParameter((Result) result, name, value, extraContext);
} else {
setParameterHelper(result, name, value, extraContext);
}
}

private void setParameterHelper(Object result, String name, String value, Map<String, Object> extraContext) {
if (result instanceof ParamNameAwareResult) {
if (((ParamNameAwareResult) result).acceptableParameterName(name, value)) {
reflectionProvider.setProperty(name, value, result, extraContext, true);
Expand All @@ -85,5 +118,4 @@ protected void setParameter(Result result, String name, String value, Map<String
reflectionProvider.setProperty(name, value, result, extraContext, true);
}
}

}