jcifs.smb.SmbNamedPipe Maven / Gradle / Ivy
Show all versions of jcifs-ng Show documentation
/* jcifs smb client library in Java
* Copyright (C) 2000 "Michael B. Allen"
* "Paul Walker"
*
* This library 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.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package jcifs.smb;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.MalformedURLException;
import jcifs.CIFSContext;
/**
* This class will allow a Java program to read and write data to Named
* Pipes and Transact NamedPipes.
*
*
* There are three Win32 function calls provided by the Windows SDK
* that are important in the context of using jCIFS. They are:
*
*
* CallNamedPipe A message-type pipe call that opens,
* writes to, reads from, and closes the pipe in a single operation.
* TransactNamedPipe A message-type pipe call that
* writes to and reads from an existing pipe descriptor in one operation.
* CreateFile, ReadFile,
* WriteFile, and CloseFile A byte-type pipe can
* be opened, written to, read from and closed using the standard Win32
* file operations.
*
*
*
* The jCIFS API maps all of these operations into the standard Java
* XxxputStream interface. A special PIPE_TYPE
* flags is necessary to distinguish which type of Named Pipe behavior
* is desired.
*
*
*
*
* SmbNamedPipe Constructor Examples
* Code Sample
* Description
*
*
*
*
*
* new SmbNamedPipe("smb://server/IPC$/PIPE/foo", SmbNamedPipe.PIPE_TYPE_RDWR | SmbNamedPipe.PIPE_TYPE_CALL, context);
*
*
*
*
* Open the Named Pipe foo for reading and writing. The pipe will behave like the CallNamedPipe interface.
*
*
*
*
*
*
* new SmbNamedPipe("smb://server/IPC$/foo", SmbNamedPipe.PIPE_TYPE_RDWR | SmbNamedPipe.PIPE_TYPE_TRANSACT, context);
*
*
*
*
* Open the Named Pipe foo for reading and writing. The pipe will behave like the TransactNamedPipe
* interface.
*
*
*
*
*
*
* new SmbNamedPipe("smb://server/IPC$/foo", SmbNamedPipe.PIPE_TYPE_RDWR, context);
*
*
*
*
* Open the Named Pipe foo for reading and writing. The pipe will
* behave as though the CreateFile, ReadFile,
* WriteFile, and CloseFile interface was
* being used.
*
*
*
*
*
* See Using jCIFS to Connect to Win32
* Named Pipes for a detailed description of how to use jCIFS with
* Win32 Named Pipe server processes.
*
*/
public class SmbNamedPipe extends SmbFile {
/**
* The pipe should be opened read-only.
*/
public static final int PIPE_TYPE_RDONLY = O_RDONLY;
/**
* The pipe should be opened only for writing.
*/
public static final int PIPE_TYPE_WRONLY = O_WRONLY;
/**
* The pipe should be opened for both reading and writing.
*/
public static final int PIPE_TYPE_RDWR = O_RDWR;
/**
* Pipe operations should behave like the CallNamedPipe Win32 Named Pipe function.
*/
public static final int PIPE_TYPE_CALL = 0x0100;
/**
* Pipe operations should behave like the TransactNamedPipe Win32 Named Pipe function.
*/
public static final int PIPE_TYPE_TRANSACT = 0x0200;
/**
* Pipe is used for DCE
*/
public static final int PIPE_TYPE_DCE_TRANSACT = 0x0200 | 0x0400;
InputStream pipeIn;
OutputStream pipeOut;
int pipeType;
/**
* Open the Named Pipe resource specified by the url
* parameter. The pipeType parameter should be at least one of
* the PIPE_TYPE flags combined with the bitwise OR
* operator |. See the examples listed above.
*
* @param url
* @param pipeType
* @param tc
* @throws MalformedURLException
*/
public SmbNamedPipe ( String url, int pipeType, CIFSContext tc ) throws MalformedURLException {
super(url, tc);
this.pipeType = pipeType;
this.type = TYPE_NAMED_PIPE;
}
/**
* Return the InputStream used to read information
* from this pipe instance. Presumably data would first be written
* to the OutputStream associated with this Named
* Pipe instance although this is not a requirement (e.g. a
* read-only named pipe would write data to this stream on
* connection). Reading from this stream may block. Therefore it
* may be necessary that an addition thread be used to read and
* write to a Named Pipe.
*
* @return pipe input stream
* @throws IOException
*/
public InputStream getNamedPipeInputStream () throws IOException {
if ( this.pipeIn == null ) {
if ( ( this.pipeType & PIPE_TYPE_CALL ) == PIPE_TYPE_CALL || ( this.pipeType & PIPE_TYPE_TRANSACT ) == PIPE_TYPE_TRANSACT ) {
this.pipeIn = new TransactNamedPipeInputStream(this);
}
else {
this.pipeIn = new SmbFileInputStream(this, ( this.pipeType & 0xFFFF00FF ) | SmbFile.O_EXCL);
}
}
return this.pipeIn;
}
/**
* Return the OutputStream used to write
* information to this pipe instance. The act of writing data
* to this stream will result in response data recieved in the
* InputStream associated with this Named Pipe
* instance (unless of course it does not elicite a response or the pipe is write-only).
*
* @return pipe output stream
* @throws IOException
*/
public OutputStream getNamedPipeOutputStream () throws IOException {
if ( this.pipeOut == null ) {
if ( ( this.pipeType & PIPE_TYPE_CALL ) == PIPE_TYPE_CALL || ( this.pipeType & PIPE_TYPE_TRANSACT ) == PIPE_TYPE_TRANSACT ) {
this.pipeOut = new TransactNamedPipeOutputStream(this);
}
else {
this.pipeOut = new SmbFileOutputStream(this, false, ( this.pipeType & 0xFFFF00FF ) | SmbFile.O_EXCL);
}
}
return this.pipeOut;
}
}