ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.developer;
ohair@286: 
ohair@286: import javax.xml.ws.spi.WebServiceFeatureAnnotation;
ohair@286: import java.lang.annotation.*;
ohair@286: import java.io.File;
ohair@286: 
ohair@286: /**
ohair@286:  * This feature represents the use of StreamingAttachment attachments with a
ohair@286:  * web service.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * for e.g.: To keep all MIME attachments in memory, do the following
ohair@286:  *
ohair@286:  * <pre>
ohair@286:  * &#64;WebService
ohair@286:  * &#64;MIME(memoryThreshold=-1L)
ohair@286:  * public class HelloService {
ohair@286:  * }
ohair@286:  * </pre>
ohair@286:  *
ohair@286:  * @see StreamingAttachmentFeature
ohair@286:  *
ohair@286:  * @author Jitendra Kotamraju
ohair@286:  */
ohair@286: @Retention(RetentionPolicy.RUNTIME)
ohair@286: @Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
ohair@286: @Documented
ohair@286: @WebServiceFeatureAnnotation(id = StreamingAttachmentFeature.ID, bean = StreamingAttachmentFeature.class)
ohair@286: public @interface StreamingAttachment {
ohair@286: 
ohair@286:     /**
ohair@286:      * Directory in which large attachments are stored. {@link File#createTempFile}
ohair@286:      * methods are used to create temp files for storing attachments. This
ohair@286:      * value is used in {@link File#createTempFile}, if specified. If a file
ohair@286:      * cannot be created in this dir, then all the content is kept in memory.
ohair@286:      */
ohair@286:     String dir() default "";
ohair@286: 
ohair@286:     /**
ohair@286:      * MIME message is parsed eagerly.
ohair@286:      */
ohair@286:     boolean parseEagerly() default false;
ohair@286: 
ohair@286:     /**
ohair@286:      * After this threshold(no of bytes per attachment), large attachment is
ohair@286:      * written to file system.
ohair@286:      *
ohair@286:      * If the value is -1, then all the attachment content is kept in memory.
ohair@286:      */
ohair@286:     long memoryThreshold() default 1048576L;
ohair@286: 
ohair@286: }