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 5 #1084

Merged
merged 4 commits into from
Oct 23, 2024
Merged

WW-3714 Deprecate and repackage common APIs part 5 #1084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a623842
WW-3714 Deprecate and migrate ActionSupport
kusalk Oct 17, 2024
9e23fbe
WW-3714 Deprecate and migrate AbstractInterceptor and MethodFilterInt…
kusalk Oct 17, 2024
f95f9a7
WW-3714 Add alternative constructors in InterceptorMapping
kusalk Oct 21, 2024
deb6c09
WW-3714 Replace deprecated APIs in new ActionSupport
kusalk Oct 21, 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
337 changes: 3 additions & 334 deletions core/src/main/java/com/opensymphony/xwork2/ActionSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,342 +18,11 @@
*/
package com.opensymphony.xwork2;

import com.opensymphony.xwork2.conversion.impl.ConversionData;
import com.opensymphony.xwork2.inject.Container;
import com.opensymphony.xwork2.inject.Inject;
import com.opensymphony.xwork2.interceptor.ValidationAware;
import com.opensymphony.xwork2.util.ValueStack;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.struts2.StrutsConstants;

import java.io.Serializable;
import java.util.*;

/**
* Provides a default implementation for the most common actions.
* See the documentation for all the interfaces this class implements for more detailed information.
* @deprecated since 6.7.0, use {@link org.apache.struts2.ActionSupport} instead.
*/
public class ActionSupport implements Action, Validateable, ValidationAware, TextProvider, LocaleProvider, Serializable {

private static final Logger LOG = LogManager.getLogger(ActionSupport.class);

private final ValidationAwareSupport validationAware = new ValidationAwareSupport();

private transient TextProvider textProvider;
private transient LocaleProvider localeProvider;

protected Container container;

@Override
public void setActionErrors(Collection<String> errorMessages) {
validationAware.setActionErrors(errorMessages);
}

@Override
public Collection<String> getActionErrors() {
return validationAware.getActionErrors();
}

@Override
public void setActionMessages(Collection<String> messages) {
validationAware.setActionMessages(messages);
}

@Override
public Collection<String> getActionMessages() {
return validationAware.getActionMessages();
}

@Override
public void setFieldErrors(Map<String, List<String>> errorMap) {
validationAware.setFieldErrors(errorMap);
}

@Override
public Map<String, List<String>> getFieldErrors() {
return validationAware.getFieldErrors();
}

@Override
public Locale getLocale() {
return getLocaleProvider().getLocale();
}

@Override
public boolean isValidLocaleString(String localeStr) {
return getLocaleProvider().isValidLocaleString(localeStr);
}

@Override
public boolean isValidLocale(Locale locale) {
return getLocaleProvider().isValidLocale(locale);
}

@Override
public Locale toLocale(String localeStr) {
return getLocaleProvider().toLocale(localeStr);
}

@Override
public boolean hasKey(String key) {
return getTextProvider().hasKey(key);
}

@Override
public String getText(String aTextName) {
return getTextProvider().getText(aTextName);
}

@Override
public String getText(String aTextName, String defaultValue) {
return getTextProvider().getText(aTextName, defaultValue);
}

@Override
public String getText(String aTextName, String defaultValue, String obj) {
return getTextProvider().getText(aTextName, defaultValue, obj);
}

@Override
public String getText(String aTextName, List<?> args) {
return getTextProvider().getText(aTextName, args);
}

@Override
public String getText(String key, String[] args) {
return getTextProvider().getText(key, args);
}

@Override
public String getText(String aTextName, String defaultValue, List<?> args) {
return getTextProvider().getText(aTextName, defaultValue, args);
}

@Override
public String getText(String key, String defaultValue, String[] args) {
return getTextProvider().getText(key, defaultValue, args);
}

@Override
public String getText(String key, String defaultValue, List<?> args, ValueStack stack) {
return getTextProvider().getText(key, defaultValue, args, stack);
}

@Override
public String getText(String key, String defaultValue, String[] args, ValueStack stack) {
return getTextProvider().getText(key, defaultValue, args, stack);
}

/**
* Dedicated method to support I10N and conversion errors
*
* @param key message which contains formatting string
* @param expr that should be formatted
* @return formatted expr with format specified by key
*/
public String getFormatted(String key, String expr) {
Map<String, ConversionData> conversionErrors = ActionContext.getContext().getConversionErrors();
if (conversionErrors.containsKey(expr)) {
String[] vals = (String[]) conversionErrors.get(expr).getValue();
return vals[0];
} else {
final ValueStack valueStack = ActionContext.getContext().getValueStack();
final Object val = valueStack.findValue(expr);
return getText(key, Arrays.asList(val));
}
}

@Override
public ResourceBundle getTexts() {
return getTextProvider().getTexts();
}

@Override
public ResourceBundle getTexts(String aBundleName) {
return getTextProvider().getTexts(aBundleName);
}

@Override
public void addActionError(String anErrorMessage) {
validationAware.addActionError(anErrorMessage);
}

@Override
public void addActionMessage(String aMessage) {
validationAware.addActionMessage(aMessage);
}

@Override
public void addFieldError(String fieldName, String errorMessage) {
validationAware.addFieldError(fieldName, errorMessage);
}

public String input() throws Exception {
return INPUT;
}

/**
* A default implementation that does nothing an returns "success".
*
* <p>
* Subclasses should override this method to provide their business logic.
* </p>
*
* <p>
* See also {@link com.opensymphony.xwork2.Action#execute()}.
* </p>
*
* @return returns {@link #SUCCESS}
* @throws Exception can be thrown by subclasses.
*/
@Override
public String execute() throws Exception {
return SUCCESS;
}

@Override
public boolean hasActionErrors() {
return validationAware.hasActionErrors();
}

@Override
public boolean hasActionMessages() {
return validationAware.hasActionMessages();
}

@Override
public boolean hasErrors() {
return validationAware.hasErrors();
}

@Override
public boolean hasFieldErrors() {
return validationAware.hasFieldErrors();
}

/**
* Clears field errors. Useful for Continuations and other situations
* where you might want to clear parts of the state on the same action.
*/
public void clearFieldErrors() {
validationAware.clearFieldErrors();
}

/**
* Clears action errors. Useful for Continuations and other situations
* where you might want to clear parts of the state on the same action.
*/
public void clearActionErrors() {
validationAware.clearActionErrors();
}

/**
* Clears messages. Useful for Continuations and other situations
* where you might want to clear parts of the state on the same action.
*/
public void clearMessages() {
validationAware.clearMessages();
}

/**
* Clears all errors. Useful for Continuations and other situations
* where you might want to clear parts of the state on the same action.
*/
public void clearErrors() {
validationAware.clearErrors();
}

/**
* Clears all errors and messages. Useful for Continuations and other situations
* where you might want to clear parts of the state on the same action.
*/
public void clearErrorsAndMessages() {
validationAware.clearErrorsAndMessages();
}

/**
* A default implementation that validates nothing.
* Subclasses should override this method to provide validations.
*/
@Override
public void validate() {
// A default implementation that validates nothing
}

@Override
public Object clone() throws CloneNotSupportedException {
return super.clone();
}

/**
* <!-- START SNIPPET: pause-method -->
* Stops the action invocation immediately (by throwing a PauseException) and causes the action invocation to return
* the specified result, such as {@link #SUCCESS}, {@link #INPUT}, etc.
*
* <p>
* The next time this action is invoked (and using the same continuation ID), the method will resume immediately
* after where this method was called, with the entire call stack in the execute method restored.
* </p>
*
* <p>
* Note: this method can <b>only</b> be called within the {@link #execute()} method.
* </p>
*
* <!-- END SNIPPET: pause-method -->
*
* @param result the result to return - the same type of return value in the {@link #execute()} method.
*/
public void pause(String result) {
}

/**
* If called first time it will create {@link com.opensymphony.xwork2.TextProviderFactory},
* inject dependency (if {@link com.opensymphony.xwork2.inject.Container} is accesible) into in,
* then will create new {@link com.opensymphony.xwork2.TextProvider} and store it in a field
* for future references and at the returns reference to that field
*
* @return reference to field with TextProvider
*/
protected TextProvider getTextProvider() {
if (textProvider == null) {
final TextProviderFactory tpf = getContainer().getInstance(TextProviderFactory.class);
textProvider = tpf.createInstance(getClass());
}
return textProvider;
}

protected LocaleProvider getLocaleProvider() {
if (localeProvider == null) {
final LocaleProviderFactory localeProviderFactory = getContainer().getInstance(LocaleProviderFactory.class);
localeProvider = localeProviderFactory.createLocaleProvider();
}
return localeProvider;
}

/**
* TODO: This a temporary solution, maybe we should consider stop injecting container into beans
*/
protected Container getContainer() {
if (container == null) {
container = ActionContext.getContext().getContainer();
if (container != null) {
boolean devMode = Boolean.parseBoolean(container.getInstance(String.class, StrutsConstants.STRUTS_DEVMODE));
if (devMode) {
LOG.warn("Container is null, action was created manually? Fallback to ActionContext");
} else {
LOG.debug("Container is null, action was created manually? Fallback to ActionContext");
}
} else {
LOG.warn("Container is null, action was created out of ActionContext scope?!?");
}
}
return container;
}

@Inject
public void setContainer(Container container) {
this.container = container;
}

@Deprecated
public class ActionSupport extends org.apache.struts2.ActionSupport implements Action, Validateable, ValidationAware {
}
10 changes: 9 additions & 1 deletion core/src/main/java/com/opensymphony/xwork2/config/entities/InterceptorMapping.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,16 @@ public class InterceptorMapping implements Serializable {
private Interceptor interceptor;
private final Map<String, String> params;

public InterceptorMapping(String name, org.apache.struts2.interceptor.Interceptor interceptor) {
this(name, Interceptor.adapt(interceptor));
}

public InterceptorMapping(String name, org.apache.struts2.interceptor.Interceptor interceptor, Map<String, String> params) {
this(name, Interceptor.adapt(interceptor), params);
}

public InterceptorMapping(String name, Interceptor interceptor) {
this(name, interceptor, new HashMap<String, String>());
this(name, interceptor, new HashMap<>());
}

public InterceptorMapping(String name, Interceptor interceptor, Map<String, String> params) {
Expand Down
Loading