javax.mvc.Models Java Examples

/**
 * Constructor for view engine contexts.
 *
 * @param view Name of view.
 * @param models Instance of models.
 * @param request HTTP servlet request.
 * @param response HTTP servlet response.
 * @param responseHeaders The response responseHeaders
 * @param outputStream The response stream
 * @param mediaType The media type
 * @param uriInfo URI info about the request.
 * @param resourceInfo Resource matched info.
 * @param configuration the configuration.
 * @param locale the request locale
 */
public ViewEngineContextImpl(String view, Models models, Object request, Object response,
                             MultivaluedMap<String, Object> responseHeaders, OutputStream outputStream,
                             MediaType mediaType, UriInfo uriInfo, ResourceInfo resourceInfo,
                             Configuration configuration, Locale locale) {
    this.view = view;
    this.models = models;
    this.request = request;
    this.response = response;
    this.responseHeaders = responseHeaders;
    this.outputStream = outputStream;
    this.mediaType = mediaType;
    this.uriInfo = uriInfo;
    this.resourceInfo = resourceInfo;
    this.configuration = configuration;
    this.locale = locale;
}
 

public SpringPortletWebContext(ApplicationContext applicationContext, Models models, String lifecyclePhase,
	HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse,
	ServletContext servletContext, Locale locale, javax.ws.rs.core.Configuration configuration) {

	super(httpServletRequest, httpServletResponse, servletContext, locale);
	this.applicationContext = applicationContext;
	this.models = models;
	this.beanNames = new HashSet<>();

	boolean portletSpecBeans = false;

	VariableValidator variableValidator = applicationContext.getBean(VariableValidator.class);

	boolean headerPhase = lifecyclePhase.equals(PortletRequest.HEADER_PHASE);
	boolean renderPhase = lifecyclePhase.equals(PortletRequest.RENDER_PHASE);
	boolean resourcePhase = lifecyclePhase.equals(PortletRequest.RESOURCE_PHASE);

	for (String beanName : applicationContext.getBeanDefinitionNames()) {

		if ((beanName != null) &&
				variableValidator.isValidName(beanName, headerPhase, renderPhase, resourcePhase)) {
			this.beanNames.add(beanName);
		}
	}
}
 

public CDIPortletWebContext(BeanManager beanManager, VariableValidator variableInspector, Models models,
	String lifecyclePhase, HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse,
	ServletContext servletContext, Locale locale) {

	super(httpServletRequest, httpServletResponse, servletContext, locale);
	this.beanManager = beanManager;
	this.models = models;
	this.beanNames = new HashSet<>();

	boolean headerPhase = lifecyclePhase.equals(PortletRequest.HEADER_PHASE);
	boolean renderPhase = lifecyclePhase.equals(PortletRequest.RENDER_PHASE);
	boolean resourcePhase = lifecyclePhase.equals(PortletRequest.RESOURCE_PHASE);

	Set<Bean<?>> beans = beanManager.getBeans(Object.class, new AnnotationLiteral<Any>() {
			});

	for (Bean<?> bean : beans) {
		String beanName = bean.getName();

		if ((beanName != null) &&
				variableInspector.isValidName(beanName, headerPhase, renderPhase, resourcePhase)) {
			this.beanNames.add(beanName);
		}
	}
}
 

/**
 * Constructor for view engine contexts.
 *
 * @param view Name of view.
 * @param models Instance of models.
 * @param request HTTP servlet request.
 * @param response HTTP servlet response.
 * @param responseHeaders The response responseHeaders
 * @param outputStream The response stream
 * @param mediaType The media type
 * @param uriInfo URI info about the request.
 * @param resourceInfo Resource matched info.
 * @param configuration the configuration.
 * @param locale the request locale
 */
public ViewEngineContextImpl(String view, Models models, Object request, Object response,
                             MultivaluedMap<String, Object> responseHeaders, OutputStream outputStream,
                             MediaType mediaType, UriInfo uriInfo, ResourceInfo resourceInfo,
                             Configuration configuration, Locale locale) {
    this.view = view;
    this.models = models;
    this.request = request;
    this.response = response;
    this.responseHeaders = responseHeaders;
    this.outputStream = outputStream;
    this.mediaType = mediaType;
    this.uriInfo = uriInfo;
    this.resourceInfo = resourceInfo;
    this.configuration = configuration;
    this.locale = locale;
}
 

@Override
public void processView(ViewEngineContext context)
        throws ViewEngineException {
    try {
        Models models = context.getModels();
        models.put("request", context.getRequest());
        models.put("locale", context.getRequest().getLocale());
        Writer writer = context.getResponse().getWriter();
        engine.getMustache(context.getView()).render(writer, models);
        writer.flush();
    } catch (IOException e) {
        throw new ViewEngineException(e);
    }
}
 

public ViewEngineContextImpl(Configuration configuration, PortletRequest portletRequest, MimeResponse mimeResponse,
	Models models, Locale locale) {
	this.configuration = configuration;
	this.portletRequest = portletRequest;
	this.mimeResponse = mimeResponse;
	this.models = models;
	this.locale = locale;
}
 

@Scope(proxyMode = ScopedProxyMode.INTERFACES, value = "portletRequest")
@Bean
public IWebContext getWebContext(MvcContext mvcContext, Models models, PortletRequest portletRequest,
	MimeResponse mimeResponse, ServletContext servletContext) {

	return new SpringPortletWebContext(applicationContext, models,
			(String) portletRequest.getAttribute(PortletRequest.LIFECYCLE_PHASE),
			new HttpServletRequestAdapter(portletRequest), new HttpServletResponseAdapter(mimeResponse),
			servletContext, mvcContext.getLocale(), mvcContext.getConfig());
}
 

@PortletRequestScoped
@Produces
public IWebContext getWebContext(BeanManager beanManager, VariableValidator variableValidator,
	MvcContext mvcContext, Models models, PortletRequest portletRequest, MimeResponse mimeResponse,
	ServletContext servletContext) {

	return new CDIPortletWebContext(beanManager, variableValidator, models,
			(String) portletRequest.getAttribute(PortletRequest.LIFECYCLE_PHASE),
			new HttpServletRequestAdapter(portletRequest), new HttpServletResponseAdapter(mimeResponse),
			servletContext, mvcContext.getLocale());
}
 

@Override
public Models getModels() {
	return models;
}
 

@Override
public Models getModels() {
    return models;
}
 

@Override
public Models put(String name, Object model) {
    Objects.requireNonNull(name, "Name must not be null");
    map.put(name, model);
    return this;
}
 

/**
 * Searches for a suitable {@link javax.mvc.engine.ViewEngine} to process the view. If no engine
 * is found, is forwards the request back to the servlet container.
 */
@Override
public void writeTo(Viewable viewable, Class<?> aClass, Type type, Annotation[] annotations, MediaType resolvedMediaType,
                    MultivaluedMap<String, Object> headers, OutputStream out)
    throws IOException, WebApplicationException {

    // Find engine for this Viewable
    final ViewEngine engine = engineFinder.find(viewable);
    if (engine == null) {
        throw new ServerErrorException(messages.get("NoViewEngine", viewable), INTERNAL_SERVER_ERROR);
    }

    // build the full media type (including the charset) and make sure the response header is set correctly
    MediaType mediaType = buildMediaTypeWithCharset(resolvedMediaType);
    headers.putSingle(HttpHeaders.CONTENT_TYPE, mediaType);

    HttpServletRequest request = unwrapOriginalRequest(injectedRequest);
    HttpServletResponse response = unwrapOriginalResponse(injectedResponse);

    // Create wrapper for response
    final ServletOutputStream responseStream = new DelegatingServletOutputStream(out);
    final HttpServletResponse responseWrapper = new MvcHttpServletResponse(response, responseStream, mediaType, headers);

    // Pass request to view engine
    try {
        // If no models in viewable, inject via CDI
        Models models = viewable.getModels();
        if (models == null) {
            models = modelsInstance.get();
        }

        // Bind EL 'mvc' object in models
        models.put("mvc", mvc);

        // Execute the view engine
        eventDispatcher.fireBeforeProcessViewEvent(engine, viewable);
        try {

            // Process view using selected engine
            engine.processView(new ViewEngineContextImpl(viewable.getView(), models, request, responseWrapper,
                                                         headers, responseStream, mediaType, uriInfo, resourceInfo, config, mvc.getLocale()));

        } finally {
            eventDispatcher.fireAfterProcessViewEvent(engine, viewable);
        }

    } catch (ViewEngineException e) {
        throw new ServerErrorException(INTERNAL_SERVER_ERROR, e);
    } finally {
        responseWrapper.getWriter().flush();
    }
}
 

@Override
public Models put(String name, Object model) {
	modelsMap.put(name, model);

	return this;
}
 

@Override
public Models getModels() {
    return models;
}
 

@Override
public Models put(String name, Object model) {
    Objects.requireNonNull(name, "Name must not be null");
    map.put(name, model);
    return this;
}
 

/**
 * Set the models instance.
 *
 * @param models the new models instance.
 */
public void setModels(Models models) {
    this.models = models;
}
 

/**
 * Constructs an instance using a view and a models instance.
 *
 * @param view the view.
 * @param models the models instance.
 */
public Viewable(String view, Models models) {
    this(view, models, null);
}
 

/**
 * Get the models instance.
 *
 * @return the models instance or {@code null}.
 */
public Models getModels() {
    return models;
}
 

/**
 * Constructs an instance using a view, a models and a view engine instances.
 *
 * @param view the view.
 * @param models the models instance.
 * @param viewEngine the view engine class.
 */
public Viewable(String view, Models models, Class<? extends ViewEngine> viewEngine) {
    this.view = view;
    this.models = models;
    this.viewEngine = viewEngine;
}
 

/**
 * Constructs an instance using a view and a models instance.
 *
 * @param view the view.
 * @param models the models instance.
 */
public Viewable(String view, Models models) {
    this(view, models, null);
}
 

/**
 * Set the models instance.
 *
 * @param models the new models instance.
 */
public void setModels(Models models) {
    this.models = models;
}
 

/**
 * Get the models instance.
 *
 * @return the models instance or {@code null}.
 */
public Models getModels() {
    return models;
}
 

/**
 * Constructs an instance using a view, a models and a view engine instances.
 *
 * @param view the view.
 * @param models the models instance.
 * @param viewEngine the view engine class.
 */
public Viewable(String view, Models models, Class<? extends ViewEngine> viewEngine) {
    this.view = view;
    this.models = models;
    this.viewEngine = viewEngine;
}