org.wings.resource.StringResource Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wings Show documentation
The newest version!
/*
 * Copyright 2000,2005 wingS development team.
 *
 * This file is part of wingS (http://wingsframework.org).
 *
 * wingS is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * Please see COPYING for the complete licence.
 */
package org.wings.resource;

import org.wings.RequestURL;
import org.wings.Resource;
import org.wings.SimpleURL;
import org.wings.externalizer.ExternalizeManager;
import org.wings.io.Device;
import org.wings.session.SessionManager;

import java.io.IOException;

/**
 * For externalizing a string as a resource.
 *
 * @author Holger Engels
 */
public class StringResource extends Resource {
    private final String string;
    private String id;

    /**
     * Flags that influence the behaviour of the externalize manager
     */
    protected int externalizerFlags;

    /**
     * Default c'tor externalizing this resource as text/plain MIME document.
     * @param string
     */
    public StringResource(String string) {
        this(string, "txt", "text/plain");
    }

    public StringResource(String string, String extension, String mimeType) {
        this(string, extension, mimeType, ExternalizeManager.FINAL);
    }

    public StringResource(String string, String extension, String mimeType,
                          int externalizerFlags) {
        super(extension, mimeType);

        this.string = string;
        this.externalizerFlags = externalizerFlags;
    }


    @Override
    public int getLength() {
        return string.length();
    }

    /**
     * Get the id that identifies this resource as an externalized object.
     * If the object has not been externalized yet, it will be externalized.
     *
     * @return the externalization id
     */
    @Override
    public String getId() {
        if (id == null) {
            ExternalizeManager ext = SessionManager.getSession().getExternalizeManager();
            id = ext.getId(ext.externalize(this, externalizerFlags));
        }
        return id;
    }

    @Override
    public SimpleURL getURL() {
        String name = getId();
        RequestURL requestURL = (RequestURL)SessionManager.getSession().getProperty("request.url");
        requestURL = (RequestURL) requestURL.clone();
        requestURL.setResource(name);
        return requestURL;
    }

    @Override
    public final void write(Device out) throws IOException {
        out.print(string);
    }

    public int getExternalizerFlags() {
        return externalizerFlags;
    }
}