/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.developer;
import com.sun.xml.ws.api.FeatureConstructor;
import com.sun.istack.Nullable;
import javax.xml.ws.WebServiceFeature;
import org.jvnet.mimepull.MIMEConfig;
import org.glassfish.gmbal.ManagedAttribute;
import org.glassfish.gmbal.ManagedData;
/**
* Proxy needs to be created with this feature to configure StreamingAttachment
* attachments behaviour.
*
* <pre>
* for e.g.: To configure all StreamingAttachment attachments to be kept in memory
* <p>
*
* StreamingAttachmentFeature feature = new StreamingAttachmentFeature();
* feature.setAllMemory(true);
*
* proxy = HelloService().getHelloPort(feature);
*
* </pre>
*
* @author Jitendra Kotamraju
*/
@ManagedData
public final class StreamingAttachmentFeature extends WebServiceFeature {
/**
* Constant value identifying the {@link @StreamingAttachment} feature.
*/
public static final String ID = "http://jax-ws.dev.java.net/features/mime";
private MIMEConfig config;
private String dir;
private boolean parseEagerly;
private long memoryThreshold;
public StreamingAttachmentFeature() {
}
@FeatureConstructor({"dir","parseEagerly","memoryThreshold"})
public StreamingAttachmentFeature(@Nullable String dir, boolean parseEagerly, long memoryThreshold) {
this.enabled = true;
this.dir = dir;
this.parseEagerly = parseEagerly;
this.memoryThreshold = memoryThreshold;
}
@ManagedAttribute
public String getID() {
return ID;
}
/**
* Returns the configuration object. Once this is called, you cannot
* change the configuration.
*
* @return
*/
@ManagedAttribute
public MIMEConfig getConfig() {
if (config == null) {
config = new MIMEConfig();
config.setDir(dir);
config.setParseEagerly(parseEagerly);
config.setMemoryThreshold(memoryThreshold);
config.validate();
}
return config;
}
/**
* Directory in which large attachments are stored
*/
public void setDir(String dir) {
this.dir = dir;
}
/**
* StreamingAttachment message is parsed eagerly
*/
public void setParseEagerly(boolean parseEagerly) {
this.parseEagerly = parseEagerly;
}
/**
* After this threshold(no of bytes), large attachments are
* written to file system
*/
public void setMemoryThreshold(int memoryThreshold) {
this.memoryThreshold = memoryThreshold;
}
}