de.mhus.lib.portlet.callback.CallContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mhu-lib-j2ee Show documentation
Show all versions of mhu-lib-j2ee Show documentation
Tools to develop J2EE applications
/**
* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction,
* and distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by
* the copyright owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all
* other entities that control, are controlled by, or are under common
* control with that entity. For the purposes of this definition,
* "control" means (i) the power, direct or indirect, to cause the
* direction or management of such entity, whether by contract or
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity
* exercising permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications,
* including but not limited to software source code, documentation
* source, and configuration files.
*
* "Object" form shall mean any form resulting from mechanical
* transformation or translation of a Source form, including but
* not limited to compiled object code, generated documentation,
* and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or
* Object form, made available under the License, as indicated by a
* copyright notice that is included in or attached to the work
* (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object
* form, that is based on (or derived from) the Work and for which the
* editorial revisions, annotations, elaborations, or other modifications
* represent, as a whole, an original work of authorship. For the purposes
* of this License, Derivative Works shall not include works that remain
* separable from, or merely link (or bind by name) to the interfaces of,
* the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including
* the original version of the Work and any modifications or additions
* to that Work or Derivative Works thereof, that is intentionally
* submitted to Licensor for inclusion in the Work by the copyright owner
* or by an individual or Legal Entity authorized to submit on behalf of
* the copyright owner. For the purposes of this definition, "submitted"
* means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems,
* and issue tracking systems that are managed by, or on behalf of, the
* Licensor for the purpose of discussing and improving the Work, but
* excluding communication that is conspicuously marked or otherwise
* designated in writing by the copyright owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity
* on behalf of whom a Contribution has been received by Licensor and
* subsequently incorporated within the Work.
*
* 2. Grant of Copyright License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the
* Work and such Derivative Works in Source or Object form.
*
* 3. Grant of Patent License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* (except as stated in this section) patent license to make, have made,
* use, offer to sell, sell, import, and otherwise transfer the Work,
* where such license applies only to those patent claims licensable
* by such Contributor that are necessarily infringed by their
* Contribution(s) alone or by combination of their Contribution(s)
* with the Work to which such Contribution(s) was submitted. If You
* institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work
* or a Contribution incorporated within the Work constitutes direct
* or contributory patent infringement, then any patent licenses
* granted to You under this License for that Work shall terminate
* as of the date such litigation is filed.
*
* 4. Redistribution. You may reproduce and distribute copies of the
* Work or Derivative Works thereof in any medium, with or without
* modifications, and in Source or Object form, provided that You
* meet the following conditions:
*
* (a) You must give any other recipients of the Work or
* Derivative Works a copy of this License; and
*
* (b) You must cause any modified files to carry prominent notices
* stating that You changed the files; and
*
* (c) You must retain, in the Source form of any Derivative Works
* that You distribute, all copyright, patent, trademark, and
* attribution notices from the Source form of the Work,
* excluding those notices that do not pertain to any part of
* the Derivative Works; and
*
* (d) If the Work includes a "NOTICE" text file as part of its
* distribution, then any Derivative Works that You distribute must
* include a readable copy of the attribution notices contained
* within such NOTICE file, excluding those notices that do not
* pertain to any part of the Derivative Works, in at least one
* of the following places: within a NOTICE text file distributed
* as part of the Derivative Works; within the Source form or
* documentation, if provided along with the Derivative Works; or,
* within a display generated by the Derivative Works, if and
* wherever such third-party notices normally appear. The contents
* of the NOTICE file are for informational purposes only and
* do not modify the License. You may add Your own attribution
* notices within Derivative Works that You distribute, alongside
* or as an addendum to the NOTICE text from the Work, provided
* that such additional attribution notices cannot be construed
* as modifying the License.
*
* You may add Your own copyright statement to Your modifications and
* may provide additional or different license terms and conditions
* for use, reproduction, or distribution of Your modifications, or
* for any such Derivative Works as a whole, provided Your use,
* reproduction, and distribution of the Work otherwise complies with
* the conditions stated in this License.
*
* 5. Submission of Contributions. Unless You explicitly state otherwise,
* any Contribution intentionally submitted for inclusion in the Work
* by You to the Licensor shall be under the terms and conditions of
* this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify
* the terms of any separate license agreement you may have executed
* with Licensor regarding such Contributions.
*
* 6. Trademarks. This License does not grant permission to use the trade
* names, trademarks, service marks, or product names of the Licensor,
* except as required for reasonable and customary use in describing the
* origin of the Work and reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty. Unless required by applicable law or
* agreed to in writing, Licensor provides the Work (and each
* Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied, including, without limitation, any warranties or conditions
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
* PARTICULAR PURPOSE. You are solely responsible for determining the
* appropriateness of using or redistributing the Work and assume any
* risks associated with Your exercise of permissions under this License.
*
* 8. Limitation of Liability. In no event and under no legal theory,
* whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law (such as deliberate and grossly
* negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special,
* incidental, or consequential damages of any character arising as a
* result of this License or out of the use or inability to use the
* Work (including but not limited to damages for loss of goodwill,
* work stoppage, computer failure or malfunction, or any and all
* other commercial damages or losses), even if such Contributor
* has been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability. While redistributing
* the Work or Derivative Works thereof, You may choose to offer,
* and charge a fee for, acceptance of support, warranty, indemnity,
* or other liability obligations and/or rights consistent with this
* License. However, in accepting such obligations, You may act only
* on Your own behalf and on Your sole responsibility, not on behalf
* of any other Contributor, and only if You agree to indemnify,
* defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason
* of your accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work.
*
* To apply the Apache License to your work, attach the following
* boilerplate notice, with the fields enclosed by brackets "{}"
* replaced with your own identifying information. (Don't include
* the brackets!) The text should be enclosed in the appropriate
* comment syntax for the file format. We also recommend that a
* file or class name and description of purpose be included on the
* same "printed page" as the copyright notice for easier
* identification within third-party archives.
*
* Copyright 2018 Mike Hummel
*
* 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 de.mhus.lib.portlet.callback;
import java.util.LinkedList;
import javax.portlet.PortletSession;
import javax.portlet.ResourceRequest;
import org.codehaus.jackson.JsonFactory;
import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonNode;
import org.codehaus.jackson.JsonParser;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.node.ArrayNode;
import org.codehaus.jackson.node.ObjectNode;
import de.mhus.lib.core.IProperties;
import de.mhus.lib.core.logging.Log;
import de.mhus.lib.core.util.MNls;
import de.mhus.lib.core.util.MNlsProvider;
import de.mhus.lib.errors.MException;
/**
* CallContext class.
*
* @author mikehummel
* @version $Id: $Id
*/
public class CallContext implements MNlsProvider {
/** Constant DEFAULT_DATA_NAME="data" */
public static final String DEFAULT_DATA_NAME = "data";
private JsonGenerator response;
private ObjectMapper mapper;
private ObjectNode node;
private MNls nls;
private LinkedList alerts;
private boolean success = true;
private ArrayNode result;
private Log log;
private ResourceRequest request;
private IProperties properties;
/**
* Constructor for CallContext.
*
* @param callback a {@link de.mhus.lib.portlet.callback.AbstractAjaxCallback} object.
* @param request a {@link javax.portlet.ResourceRequest} object.
* @param response a {@link org.codehaus.jackson.JsonGenerator} object.
*/
public CallContext(AbstractAjaxCallback callback, ResourceRequest request, JsonGenerator response) {
this.request = request;
this.response = response;
// this.callback = callback;
this.log = callback.getLog();
this.nls = callback.getNls();
mapper = new ObjectMapper();
node = mapper.createObjectNode();
result = node.putArray("results");
properties =callback.createProperties(request);
}
/**
* addSuccess.
*
* @param msg a {@link java.lang.String} object.
*/
public void addSuccess(String msg) {
addAlert(new Alert(Alert.PRIORITY.SUCCESS, msg), true);
}
/**
* addError.
*
* @param error a {@link java.lang.String} object.
*/
public void addError(String error) {
addAlert(new Alert(Alert.PRIORITY.ERROR, error), true);
}
/**
* addWarning.
*
* @param warning a {@link java.lang.String} object.
*/
public void addWarning(String warning) {
addAlert(new Alert(Alert.PRIORITY.WARNING, warning), true);
}
/**
* addInforamtion.
*
* @param info a {@link java.lang.String} object.
*/
public void addInforamtion(String info) {
addAlert(new Alert(Alert.PRIORITY.INFO, info), true);
}
/**
* addAlert.
*
* @param alert a {@link de.mhus.lib.portlet.callback.CallContext.Alert} object.
* @param useNls a boolean.
*/
public void addAlert(Alert alert, boolean useNls) {
String msg = alert.msg;
alert.msg = MNls.find(this, msg);
if (alerts == null)
alerts = new LinkedList();
alerts.add(alert);
}
/**
* setRuntimeError.
*
* @param t a {@link java.lang.Throwable} object.
*/
public void setRuntimeError(Throwable t) {
log.e(t);
if (alerts != null) alerts.clear();
addError(t.toString());
setSuccess(false);
}
/**
* Setter for the field success.
*
* @param success a boolean.
*/
public void setSuccess(boolean success) {
this.success = success;
}
/**
* doSend.
*/
public void doSend() {
if (!success) {
result.removeAll();
}
node.put("success", success ? 1 : 0);
if (alerts != null) {
ArrayNode sub = node.putArray("alerts");
for (Alert alert : alerts) {
ObjectNode line = sub.addObject();
alert.print(line);
}
}
response.setCodec(mapper);
try {
response.writeTree(node);
} catch (Exception e) {
log.e(e);
}
}
/** {@inheritDoc} */
@Override
public MNls getNls() {
return nls;
}
/**
* Setter for the field nls.
*
* @param mNls a {@link de.mhus.lib.core.util.MNls} object.
*/
public void setNls(MNls mNls) {
this.nls = mNls;
}
/**
* Getter for the field request.
*
* @return a {@link javax.portlet.ResourceRequest} object.
*/
public ResourceRequest getRequest() {
return request;
}
/**
* log.
*
* @return a {@link de.mhus.lib.core.logging.Log} object.
*/
public Log log() {
return log;
}
/**
* addResult.
*
* @return a {@link org.codehaus.jackson.node.ObjectNode} object.
*/
public ObjectNode addResult() {
return result.addObject();
}
public static class Alert {
private PRIORITY type;
private String msg;
public Alert(PRIORITY type, String msg) {
this.type = type;
this.msg = msg;
}
public void print(ObjectNode line) {
line.put("message", msg);
line.put("priority", type.name().toLowerCase());
if (type == PRIORITY.ERROR) {
line.put("fade", 0);
}
}
public enum PRIORITY {ERROR,INFO,WARNING,SUCCESS};
}
/**
* getSession.
*
* @return a {@link javax.portlet.PortletSession} object.
*/
public PortletSession getSession() {
return getRequest().getPortletSession();
}
/**
* Getter for the field properties.
*
* @return a {@link de.mhus.lib.core.IProperties} object.
*/
public IProperties getProperties() {
return properties;
}
/**
* getData.
*
* @return a {@link org.codehaus.jackson.JsonNode} object.
* @throws de.mhus.lib.errors.MException if any.
*/
public JsonNode getData() throws MException {
return getData(DEFAULT_DATA_NAME);
}
/**
* getData.
*
* @param attributeName a {@link java.lang.String} object.
* @return a {@link org.codehaus.jackson.JsonNode} object.
* @throws de.mhus.lib.errors.MException if any.
*/
public JsonNode getData(String attributeName) throws MException {
JsonNode in = null;
String dataStr = getProperties().getString(attributeName);
if (dataStr != null && !dataStr.equals("undefined")) {
try {
JsonFactory f = new JsonFactory();
ObjectMapper mapper = new ObjectMapper();
JsonParser parser = f.createJsonParser(dataStr);
in = mapper.readTree(parser);
} catch (Throwable t) {}
}
return in;
}
}