Search in sources :

Example 1 with UnifiedResponse

use of com.helger.servlet.response.UnifiedResponse in project ph-web by phax.

the class AbstractXFilterUnifiedResponse method onFilterBefore.

@Override
@Nonnull
@OverrideOnDemand
public final EContinue onFilterBefore(@Nonnull final HttpServletRequest aHttpRequest, @Nonnull final HttpServletResponse aHttpResponse, @Nonnull final IRequestWebScope aRequestScope) throws IOException, ServletException {
    // Check HTTP version
    final EHttpVersion eHTTPVersion = RequestHelper.getHttpVersion(aHttpRequest);
    if (eHTTPVersion == null) {
        aHttpResponse.sendError(HttpServletResponse.SC_HTTP_VERSION_NOT_SUPPORTED);
        return EContinue.BREAK;
    }
    // Check HTTP Method
    final EHttpMethod eHTTPMethod = RequestHelper.getHttpMethod(aHttpRequest);
    if (eHTTPMethod == null) {
        if (eHTTPVersion.is10())
            aHttpResponse.sendError(HttpServletResponse.SC_BAD_REQUEST);
        else
            aHttpResponse.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED);
        return EContinue.BREAK;
    }
    // Start unified response handling
    final UnifiedResponse aUnifiedResponse = new UnifiedResponse(eHTTPVersion, eHTTPMethod, aHttpRequest);
    if (onFilterBefore(aRequestScope, aUnifiedResponse).isBreak()) {
        // Filter ended chain -> send response
        aUnifiedResponse.applyToResponse(aHttpResponse);
        return EContinue.BREAK;
    }
    // Discard the content of the unified response
    return EContinue.CONTINUE;
}
Also used : UnifiedResponse(com.helger.servlet.response.UnifiedResponse) EHttpVersion(com.helger.http.EHttpVersion) EHttpMethod(com.helger.commons.http.EHttpMethod) Nonnull(javax.annotation.Nonnull) OverrideOnDemand(com.helger.commons.annotation.OverrideOnDemand)

Example 2 with UnifiedResponse

use of com.helger.servlet.response.UnifiedResponse in project ph-web by phax.

the class XServletHandlerToSimpleHandler method onRequest.

public void onRequest(@Nonnull final HttpServletRequest aHttpRequest, @Nonnull final HttpServletResponse aHttpResponse, @Nonnull final EHttpVersion eHttpVersion, @Nonnull final EHttpMethod eHttpMethod, @Nonnull final IRequestWebScope aRequestScope) throws ServletException, IOException {
    final UnifiedResponse aUnifiedResponse = m_aSimpleHandler.createUnifiedResponse(eHttpVersion, eHttpMethod, aHttpRequest, aRequestScope);
    if (m_aSimpleHandler.initRequestState(aRequestScope, aUnifiedResponse).isBreak()) {
        if (LOGGER.isDebugEnabled())
            LOGGER.debug("Cancelled request after initRequestState with response " + aUnifiedResponse);
    // May e.g. be an 404 error for some not-found resource
    } else {
        // Init was successful
        // Check for last-modification on GET and HEAD
        boolean bExecute = true;
        if (eHttpMethod == EHttpMethod.GET || eHttpMethod == EHttpMethod.HEAD)
            if (_handleETag(aHttpRequest, aRequestScope, aUnifiedResponse).isBreak()) {
                // ETag present in request
                aUnifiedResponse.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
                bExecute = false;
            }
        if (bExecute) {
            // On request begin
            try {
                m_aSimpleHandler.onRequestBegin(aRequestScope);
            } catch (final Exception ex) {
                _onException(aRequestScope, aUnifiedResponse, ex);
            }
            Throwable aCaughtException = null;
            try {
                // main servlet handling
                m_aSimpleHandler.handleRequest(aRequestScope, aUnifiedResponse);
                if (LOGGER.isDebugEnabled())
                    LOGGER.debug("Successfully handled request: " + aRequestScope.getPathWithinServlet());
            } catch (final ForcedRedirectException ex) {
                // Pass through
                throw ex;
            } catch (final Exception ex) {
                // Invoke exception handler
                // This internally re-throws the exception if needed
                aCaughtException = ex;
                _onException(aRequestScope, aUnifiedResponse, ex);
            } finally {
                // On request end
                try {
                    m_aSimpleHandler.onRequestEnd(aCaughtException);
                } catch (final Exception ex) {
                    LOGGER.error("onRequestEnd failed", ex);
                // Don't throw anything here
                }
            }
        }
    }
    aUnifiedResponse.applyToResponse(aHttpResponse);
}
Also used : UnifiedResponse(com.helger.servlet.response.UnifiedResponse) ForcedRedirectException(com.helger.xservlet.forcedredirect.ForcedRedirectException) ServletException(javax.servlet.ServletException) ForcedRedirectException(com.helger.xservlet.forcedredirect.ForcedRedirectException) IOException(java.io.IOException)

Example 3 with UnifiedResponse

use of com.helger.servlet.response.UnifiedResponse in project phoss-smp by phax.

the class APIExecutorImportXMLVer1 method invokeAPI.

public void invokeAPI(@Nonnull final IAPIDescriptor aAPIDescriptor, @Nonnull @Nonempty final String sPath, @Nonnull final Map<String, String> aPathVariables, @Nonnull final IRequestWebScopeWithoutResponse aRequestScope, @Nonnull final UnifiedResponse aUnifiedResponse) throws Exception {
    final ISMPServerAPIDataProvider aDataProvider = new SMPRestDataProvider(aRequestScope, null);
    // Is the writable API disabled?
    if (SMPMetaManager.getSettings().isRESTWritableAPIDisabled()) {
        throw new SMPPreconditionFailedException("The writable REST API is disabled. importServiceGroups will not be executed", aDataProvider.getCurrentURI());
    }
    final String sLogPrefix = "[REST API Import-XML-V1] ";
    final String sPathUserLoginName = aPathVariables.get(SMPRestFilter.PARAM_USER_ID);
    LOGGER.info(sLogPrefix + "Starting Import");
    // Only authenticated user may do so
    final BasicAuthClientCredentials aBasicAuth = getMandatoryAuth(aRequestScope.headers());
    SMPUserManagerPhoton.validateUserCredentials(aBasicAuth);
    // Start action after authentication
    final ISMPServiceGroupManager aServiceGroupMgr = SMPMetaManager.getServiceGroupMgr();
    final ISMPBusinessCardManager aBusinessCardMgr = SMPMetaManager.getBusinessCardMgr();
    final IUserManager aUserMgr = PhotonSecurityManager.getUserMgr();
    final ICommonsSet<String> aAllServiceGroupIDs = aServiceGroupMgr.getAllSMPServiceGroupIDs();
    final ICommonsSet<String> aAllBusinessCardIDs = aBusinessCardMgr.getAllSMPBusinessCardIDs();
    // Try to use ID or login name
    IUser aDefaultOwner = aUserMgr.getUserOfID(sPathUserLoginName);
    if (aDefaultOwner == null)
        aDefaultOwner = aUserMgr.getUserOfLoginName(sPathUserLoginName);
    if (aDefaultOwner == null || aDefaultOwner.isDeleted()) {
        // Setting the owner to a disabled user might make sense
        throw new SMPBadRequestException(sLogPrefix + "The user ID or login name '" + sPathUserLoginName + "' does not exist", aDataProvider.getCurrentURI());
    }
    LOGGER.info(sLogPrefix + "Using '" + aDefaultOwner.getID() + "' / '" + aDefaultOwner.getLoginName() + "' as the default owner");
    final boolean bOverwriteExisting = aRequestScope.params().getAsBoolean(PARAM_OVERVWRITE_EXISTING, DEFAULT_OVERWRITE_EXISTING);
    final byte[] aPayload = StreamHelper.getAllBytes(aRequestScope.getRequest().getInputStream());
    final IMicroDocument aDoc = MicroReader.readMicroXML(aPayload);
    if (aDoc == null || aDoc.getDocumentElement() == null) {
        // Cannot parse
        throw new SMPBadRequestException("Failed to parse XML payload", aDataProvider.getCurrentURI());
    }
    final String sVersion = aDoc.getDocumentElement().getAttributeValue(CSMPExchange.ATTR_VERSION);
    if (!CSMPExchange.VERSION_10.equals(sVersion)) {
        throw new SMPBadRequestException("The provided payload is not an XML file version 1.0", aDataProvider.getCurrentURI());
    }
    // Version 1.0
    LOGGER.info(sLogPrefix + "The provided payload is an XML file version 1.0");
    final ZonedDateTime aQueryDT = PDTFactory.getCurrentZonedDateTimeUTC();
    final StopWatch aSW = StopWatch.createdStarted();
    // Start the import
    final ICommonsList<ImportActionItem> aActionList = new CommonsArrayList<>();
    final ImportSummary aImportSummary = new ImportSummary();
    ServiceGroupImport.importXMLVer10(aDoc.getDocumentElement(), bOverwriteExisting, aDefaultOwner, aAllServiceGroupIDs, aAllBusinessCardIDs, aActionList, aImportSummary);
    aSW.stop();
    LOGGER.info(sLogPrefix + "Finished import after " + aSW.getMillis() + " milliseconds");
    // Everything added to the action list is already logged
    final boolean bResponseAsXML = true;
    if (bResponseAsXML) {
        // Create XML version
        final IMicroDocument aResponseDoc = new MicroDocument();
        final IMicroElement eRoot = aResponseDoc.appendElement("importResult");
        eRoot.setAttribute("version", "1");
        eRoot.setAttribute("importStartDateTime", PDTWebDateHelper.getAsStringXSD(aQueryDT));
        final IMicroElement eSettings = eRoot.appendElement("settings");
        eSettings.setAttribute("overwriteExisting", bOverwriteExisting);
        eSettings.setAttribute("defaultOwnerID", aDefaultOwner.getID());
        eSettings.setAttribute("defaultOwnerLoginName", aDefaultOwner.getLoginName());
        final ICommonsMap<String, MutableInt> aErrorLevelCount = new CommonsTreeMap<>();
        for (final ImportActionItem aAction : aActionList) {
            eRoot.appendChild(aAction.getAsMicroElement("action"));
            aErrorLevelCount.computeIfAbsent(aAction.getErrorLevelName(), k -> new MutableInt(0)).inc();
        }
        {
            final IMicroElement eSummary = eRoot.appendElement("summary");
            eSummary.setAttribute("durationMillis", aSW.getMillis());
            for (final Map.Entry<String, MutableInt> aEntry : aErrorLevelCount.entrySet()) eSummary.appendElement("errorlevel").setAttribute("id", aEntry.getKey()).setAttribute("count", aEntry.getValue().intValue());
            aImportSummary.appendTo(eSummary);
        }
        final XMLWriterSettings aXWS = new XMLWriterSettings().setIndent(EXMLSerializeIndent.INDENT_AND_ALIGN);
        aUnifiedResponse.setContentAndCharset(MicroWriter.getNodeAsString(aResponseDoc, aXWS), aXWS.getCharset()).setMimeType(new MimeType(CMimeType.APPLICATION_XML).addParameter(CMimeType.PARAMETER_NAME_CHARSET, aXWS.getCharset().name()));
    } else {
        // Create JSON version
        final IJsonObject aJson = new JsonObject();
        aJson.add("version", "1");
        aJson.add("importStartDateTime", DateTimeFormatter.ISO_ZONED_DATE_TIME.format(aQueryDT));
        aJson.addJson("settings", new JsonObject().add("overwriteExisting", bOverwriteExisting).add("defaultOwnerID", aDefaultOwner.getID()).add("defaultOwnerLoginName", aDefaultOwner.getLoginName()));
        final IJsonArray aActions = new JsonArray();
        final ICommonsMap<String, MutableInt> aLevelCount = new CommonsTreeMap<>();
        for (final ImportActionItem aAction : aActionList) {
            aActions.add(aAction.getAsJsonObject());
            aLevelCount.computeIfAbsent(aAction.getErrorLevelName(), k -> new MutableInt(0)).inc();
        }
        aJson.addJson("actions", aActions);
        {
            final IJsonObject aSummary = new JsonObject();
            aSummary.add("durationMillis", aSW.getMillis());
            final IJsonArray aLevels = new JsonArray();
            for (final Map.Entry<String, MutableInt> aEntry : aLevelCount.entrySet()) aLevels.add(new JsonObject().add("id", aEntry.getKey()).add("count", aEntry.getValue().intValue()));
            aSummary.addJson("errorlevels", aLevels);
            aImportSummary.appendTo(aSummary);
            aJson.addJson("summary", aSummary);
        }
        final String sRet = new JsonWriter(JsonWriterSettings.DEFAULT_SETTINGS_FORMATTED).writeAsString(aJson);
        aUnifiedResponse.setContentAndCharset(sRet, StandardCharsets.UTF_8).setMimeType(CMimeType.APPLICATION_JSON);
    }
    aUnifiedResponse.disableCaching();
}
Also used : IAPIDescriptor(com.helger.photon.api.IAPIDescriptor) StreamHelper(com.helger.commons.io.stream.StreamHelper) ZonedDateTime(java.time.ZonedDateTime) LoggerFactory(org.slf4j.LoggerFactory) CommonsTreeMap(com.helger.commons.collection.impl.CommonsTreeMap) IMicroDocument(com.helger.xml.microdom.IMicroDocument) IUserManager(com.helger.photon.security.user.IUserManager) JsonWriterSettings(com.helger.json.serialize.JsonWriterSettings) CMimeType(com.helger.commons.mime.CMimeType) Nonempty(com.helger.commons.annotation.Nonempty) PDTFactory(com.helger.commons.datetime.PDTFactory) ISMPServerAPIDataProvider(com.helger.phoss.smp.restapi.ISMPServerAPIDataProvider) IUser(com.helger.photon.security.user.IUser) IMicroElement(com.helger.xml.microdom.IMicroElement) Map(java.util.Map) XMLWriterSettings(com.helger.xml.serialize.write.XMLWriterSettings) StandardCharsets(java.nio.charset.StandardCharsets) JsonObject(com.helger.json.JsonObject) ICommonsList(com.helger.commons.collection.impl.ICommonsList) IJsonArray(com.helger.json.IJsonArray) UnifiedResponse(com.helger.servlet.response.UnifiedResponse) MimeType(com.helger.commons.mime.MimeType) ICommonsMap(com.helger.commons.collection.impl.ICommonsMap) ISMPServiceGroupManager(com.helger.phoss.smp.domain.servicegroup.ISMPServiceGroupManager) PhotonSecurityManager(com.helger.photon.security.mgr.PhotonSecurityManager) ImportSummary(com.helger.phoss.smp.exchange.ImportSummary) ISMPBusinessCardManager(com.helger.phoss.smp.domain.businesscard.ISMPBusinessCardManager) ICommonsSet(com.helger.commons.collection.impl.ICommonsSet) SMPBadRequestException(com.helger.phoss.smp.exception.SMPBadRequestException) BasicAuthClientCredentials(com.helger.http.basicauth.BasicAuthClientCredentials) CSMPExchange(com.helger.phoss.smp.exchange.CSMPExchange) IJsonObject(com.helger.json.IJsonObject) ImportActionItem(com.helger.phoss.smp.exchange.ImportActionItem) MicroDocument(com.helger.xml.microdom.MicroDocument) JsonArray(com.helger.json.JsonArray) Nonnull(javax.annotation.Nonnull) IRequestWebScopeWithoutResponse(com.helger.web.scope.IRequestWebScopeWithoutResponse) Logger(org.slf4j.Logger) CommonsArrayList(com.helger.commons.collection.impl.CommonsArrayList) MutableInt(com.helger.commons.mutable.MutableInt) SMPPreconditionFailedException(com.helger.phoss.smp.exception.SMPPreconditionFailedException) SMPMetaManager(com.helger.phoss.smp.domain.SMPMetaManager) PDTWebDateHelper(com.helger.commons.datetime.PDTWebDateHelper) ServiceGroupImport(com.helger.phoss.smp.exchange.ServiceGroupImport) JsonWriter(com.helger.json.serialize.JsonWriter) MicroWriter(com.helger.xml.microdom.serialize.MicroWriter) StopWatch(com.helger.commons.timing.StopWatch) DateTimeFormatter(java.time.format.DateTimeFormatter) EXMLSerializeIndent(com.helger.xml.serialize.write.EXMLSerializeIndent) MicroReader(com.helger.xml.microdom.serialize.MicroReader) SMPUserManagerPhoton(com.helger.phoss.smp.domain.user.SMPUserManagerPhoton) ISMPServiceGroupManager(com.helger.phoss.smp.domain.servicegroup.ISMPServiceGroupManager) IUserManager(com.helger.photon.security.user.IUserManager) ImportSummary(com.helger.phoss.smp.exchange.ImportSummary) ImportActionItem(com.helger.phoss.smp.exchange.ImportActionItem) JsonObject(com.helger.json.JsonObject) IJsonObject(com.helger.json.IJsonObject) CMimeType(com.helger.commons.mime.CMimeType) MimeType(com.helger.commons.mime.MimeType) IMicroDocument(com.helger.xml.microdom.IMicroDocument) MicroDocument(com.helger.xml.microdom.MicroDocument) ZonedDateTime(java.time.ZonedDateTime) IJsonObject(com.helger.json.IJsonObject) ISMPServerAPIDataProvider(com.helger.phoss.smp.restapi.ISMPServerAPIDataProvider) IUser(com.helger.photon.security.user.IUser) SMPBadRequestException(com.helger.phoss.smp.exception.SMPBadRequestException) XMLWriterSettings(com.helger.xml.serialize.write.XMLWriterSettings) JsonWriter(com.helger.json.serialize.JsonWriter) CommonsTreeMap(com.helger.commons.collection.impl.CommonsTreeMap) StopWatch(com.helger.commons.timing.StopWatch) IJsonArray(com.helger.json.IJsonArray) JsonArray(com.helger.json.JsonArray) ISMPBusinessCardManager(com.helger.phoss.smp.domain.businesscard.ISMPBusinessCardManager) SMPPreconditionFailedException(com.helger.phoss.smp.exception.SMPPreconditionFailedException) BasicAuthClientCredentials(com.helger.http.basicauth.BasicAuthClientCredentials) IMicroElement(com.helger.xml.microdom.IMicroElement) MutableInt(com.helger.commons.mutable.MutableInt) IJsonArray(com.helger.json.IJsonArray) IMicroDocument(com.helger.xml.microdom.IMicroDocument) CommonsArrayList(com.helger.commons.collection.impl.CommonsArrayList)

Aggregations

UnifiedResponse (com.helger.servlet.response.UnifiedResponse)3 Nonempty (com.helger.commons.annotation.Nonempty)1 OverrideOnDemand (com.helger.commons.annotation.OverrideOnDemand)1 CommonsArrayList (com.helger.commons.collection.impl.CommonsArrayList)1 CommonsTreeMap (com.helger.commons.collection.impl.CommonsTreeMap)1 ICommonsList (com.helger.commons.collection.impl.ICommonsList)1 ICommonsMap (com.helger.commons.collection.impl.ICommonsMap)1 ICommonsSet (com.helger.commons.collection.impl.ICommonsSet)1 PDTFactory (com.helger.commons.datetime.PDTFactory)1 PDTWebDateHelper (com.helger.commons.datetime.PDTWebDateHelper)1 EHttpMethod (com.helger.commons.http.EHttpMethod)1 StreamHelper (com.helger.commons.io.stream.StreamHelper)1 CMimeType (com.helger.commons.mime.CMimeType)1 MimeType (com.helger.commons.mime.MimeType)1 MutableInt (com.helger.commons.mutable.MutableInt)1 StopWatch (com.helger.commons.timing.StopWatch)1 EHttpVersion (com.helger.http.EHttpVersion)1 BasicAuthClientCredentials (com.helger.http.basicauth.BasicAuthClientCredentials)1 IJsonArray (com.helger.json.IJsonArray)1 IJsonObject (com.helger.json.IJsonObject)1