Package com.perforce.p4java.impl.mapbased.rpc

Class ExternalEnv

java.lang.Object

com.perforce.p4java.impl.mapbased.rpc.ExternalEnv

All Implemented Interfaces:

RpcMarshalable

public class ExternalEnv
extends Object
implements RpcMarshalable

Used as a container for each Perforce RPC call's external (operating system, calling program, etc.) environment. Serialized as the first part of most client-side RPC user command calls. Only sent once per user command dispatch loop (as far as is known).

Constructor Summary

Constructors

Constructor	Description
ExternalEnv(String progName, String version, String client, String cwd, String host, String port, String language, String os, String user, boolean unicode, Charset currentCharset)

Method Summary

Modifier and Type	Method	Description
String	getClient()
Charset	getCurrentCharset()
String	getCwd()
String	getHost()
String	getLanguage()
String	getOs()
String	getPort()
String	getProgName()
String	getUser()
String	getVersion()
boolean	isUnicode()
byte[]	marshal()
void	marshal(ByteBuffer buf)	Marshal the associated object onto the passed-in ByteBuffer.
void	setClient(String client)
void	setCurrentCharset(Charset currentCharset)
void	setCwd(String cwd)
void	setHost(String host)
void	setLanguage(String language)
void	setOs(String os)
void	setPort(String port)
void	setProgName(String progName)
void	setUnicode(boolean unicode)
void	setUser(String user)
void	setVersion(String version)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ExternalEnv

public ExternalEnv(String progName,
 String version,
 String client,
 String cwd,
 String host,
 String port,
 String language,
 String os,
 String user,
 boolean unicode,
 Charset currentCharset)

Method Details

marshal

public void marshal(ByteBuffer buf)
             throws BufferOverflowException

Description copied from interface: RpcMarshalable

Marshal the associated object onto the passed-in ByteBuffer.

Specified by:

marshal in interface RpcMarshalable

Parameters:

buf - non-null ByteBuffer; should be big enough to take the marshaled object

Throws:

BufferOverflowException - if the passed-in buffer wasn't big enough

marshal

public byte[] marshal()

toString

public String toString()

Overrides:

toString in class Object

getProgName

public String getProgName()

setProgName

public void setProgName(String progName)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getClient

public String getClient()

setClient

public void setClient(String client)

getCwd

public String getCwd()

setCwd

public void setCwd(String cwd)

getHost

public String getHost()

setHost

public void setHost(String host)

getPort

public String getPort()

setPort

public void setPort(String port)

getLanguage

public String getLanguage()

setLanguage

public void setLanguage(String language)

getOs

public String getOs()

setOs

public void setOs(String os)

getUser

public String getUser()

setUser

public void setUser(String user)

isUnicode

public boolean isUnicode()

setUnicode

public void setUnicode(boolean unicode)

getCurrentCharset

public Charset getCurrentCharset()

setCurrentCharset

public void setCurrentCharset(Charset currentCharset)