jcifs.smb
Class SmbNamedPipe
java.lang.Object
|
+--java.net.URLConnection
|
+--jcifs.smb.SmbFile
|
+--jcifs.smb.SmbNamedPipe
- public class SmbNamedPipe
- extends SmbFile
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 );
|
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 );
|
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 );
|
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.
Field Summary |
static int |
PIPE_TYPE_CALL
Pipe operations should behave like the CallNamedPipe Win32 Named Pipe function. |
static int |
PIPE_TYPE_RDONLY
The pipe should be opened read-only. |
static int |
PIPE_TYPE_RDWR
The pipe should be opened for both reading and writing. |
static int |
PIPE_TYPE_TRANSACT
Pipe operations should behave like the TransactNamedPipe Win32 Named Pipe function. |
static int |
PIPE_TYPE_WRONLY
The pipe should be opened only for writing. |
Fields inherited from class jcifs.smb.SmbFile |
ATTR_ARCHIVE, ATTR_DIRECTORY, ATTR_HIDDEN, ATTR_READONLY, ATTR_SYSTEM, ATTR_VOLUME, FILE_NO_SHARE, FILE_SHARE_DELETE, FILE_SHARE_READ, FILE_SHARE_WRITE, TYPE_COMM, TYPE_FILESYSTEM, TYPE_NAMED_PIPE, TYPE_PRINTER, TYPE_SERVER, TYPE_SHARE, TYPE_WORKGROUP |
Fields inherited from class java.net.URLConnection |
allowUserInteraction, connected, doInput, doOutput, ifModifiedSince, url, useCaches |
Method Summary |
java.io.InputStream |
getNamedPipeInputStream()
Return the InputStream used to read information
from this pipe instance. |
java.io.OutputStream |
getNamedPipeOutputStream()
Return the OutputStream used to write
information to this pipe instance. |
Methods inherited from class jcifs.smb.SmbFile |
canRead, canWrite, connect, copyTo, createNewFile, createTime, delete, equals, exists, getAttributes, getCanonicalPath, getContentLength, getDate, getDfsPath, getDiskFreeSpace, getInputStream, getLastModified, getName, getParent, getPath, getServer, getShare, getType, getUncPath, hashCode, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listFiles, mkdir, mkdirs, renameTo, setAttributes, setCreateTime, setLastModified, setReadOnly, setReadWrite, toString, toURL |
Methods inherited from class java.net.URLConnection |
getAllowUserInteraction, getContent, getContent, getContentEncoding, getContentType, getDefaultAllowUserInteraction, getDefaultRequestProperty, getDefaultUseCaches, getDoInput, getDoOutput, getExpiration, getFileNameMap, getHeaderField, getHeaderField, getHeaderFieldDate, getHeaderFieldInt, getHeaderFieldKey, getIfModifiedSince, getOutputStream, getPermission, getRequestProperty, getURL, getUseCaches, guessContentTypeFromName, guessContentTypeFromStream, setAllowUserInteraction, setContentHandlerFactory, setDefaultAllowUserInteraction, setDefaultRequestProperty, setDefaultUseCaches, setDoInput, setDoOutput, setFileNameMap, setIfModifiedSince, setRequestProperty, setUseCaches |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
PIPE_TYPE_RDONLY
public static final int PIPE_TYPE_RDONLY
- The pipe should be opened read-only.
PIPE_TYPE_WRONLY
public static final int PIPE_TYPE_WRONLY
- The pipe should be opened only for writing.
PIPE_TYPE_RDWR
public static final int PIPE_TYPE_RDWR
- The pipe should be opened for both reading and writing.
PIPE_TYPE_CALL
public static final int PIPE_TYPE_CALL
- Pipe operations should behave like the
CallNamedPipe
Win32 Named Pipe function.
PIPE_TYPE_TRANSACT
public static final int PIPE_TYPE_TRANSACT
- Pipe operations should behave like the
TransactNamedPipe
Win32 Named Pipe function.
SmbNamedPipe
public SmbNamedPipe(java.lang.String url,
int pipeType)
throws java.net.MalformedURLException,
java.net.UnknownHostException
- 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.
SmbNamedPipe
public SmbNamedPipe(java.lang.String url,
int pipeType,
NtlmPasswordAuthentication auth)
throws java.net.MalformedURLException,
java.net.UnknownHostException
SmbNamedPipe
public SmbNamedPipe(java.net.URL url,
int pipeType,
NtlmPasswordAuthentication auth)
throws java.net.MalformedURLException,
java.net.UnknownHostException
getNamedPipeInputStream
public java.io.InputStream getNamedPipeInputStream()
throws java.io.IOException
- 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.
getNamedPipeOutputStream
public java.io.OutputStream getNamedPipeOutputStream()
throws java.io.IOException
- 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).