Index (Crystal Palace API)

A B C D E G H I K L M N P R S T
All Classes All Packages

A

addLogger(SpecLogger) - Method in class crystalpalace.spec.LinkSpec: register a logger to receive output (e.g., echo command) from Crystal Palace.
arch - Variable in class crystalpalace.spec.Capability: the architecture of the capability (e.g., x86, x64)
author - Variable in class crystalpalace.spec.LinkSpec: the author of this .spec file (if specified)

B

buildPic(String, Map) - Method in class crystalpalace.spec.LinkSpec: Deprecated.
as of release 12.01.25. Use Capability.None(java.lang.String) and LinkSpec.run(Capability, Map)

C

Capability - Class in crystalpalace.spec: A class to parse a DLL or COFF Object and extract API/link arguments from it.
Capability(String, byte[], String, String) - Constructor for class crystalpalace.spec.Capability: Internal constructor to create a Capability.
contents - Variable in class crystalpalace.spec.Capability: The contents of the capability
crystalpalace.spec - package crystalpalace.spec

D

description - Variable in class crystalpalace.spec.LinkSpec: a description of the tradecraft/technique in this .spec file

E

errors - Variable in exception crystalpalace.spec.SpecParseException: A collection of errors we found

G

getArch() - Method in class crystalpalace.spec.Capability: Get the CPU arch (e.g., x86, x64) of our capability
getArgument() - Method in exception crystalpalace.spec.SpecProgramException: Returns the argument to the was-executing command.
getAuthor() - Method in class crystalpalace.spec.LinkSpec: Return the author of this tradecraft.
getCommand() - Method in exception crystalpalace.spec.SpecProgramException: Returns the last command that was run or running when this error occured.
getContents() - Method in class crystalpalace.spec.Capability: Get the contents of this capability
getDescription() - Method in class crystalpalace.spec.LinkSpec: Return a description of the technique/tradecraft.
getErrors() - Method in exception crystalpalace.spec.SpecParseException: Get the parsing errors that were discovered while parsing this file.
getFile() - Method in class crystalpalace.spec.LinkSpec: Get the name of the file associated with this .spec.
getFile() - Method in exception crystalpalace.spec.SpecParseException: Get the file associated with this exception
getFile() - Method in exception crystalpalace.spec.SpecProgramException: Get the file associated with this program.
getFileName() - Method in exception crystalpalace.spec.SpecProgramException: Get the shortname of the file where this error occured.
getKey() - Method in class crystalpalace.spec.Capability: Get the $KEY used for this specific capability.
getLabel() - Method in class crystalpalace.spec.Capability: Get the preferred Crystal Palace target label for this capability (e.g., x64.dll)
getMessage() - Method in exception crystalpalace.spec.SpecParseException: Returns a generic error message string, something like Error(s) parsing [file here].
getMessage() - Method in exception crystalpalace.spec.SpecProgramException: Get the description of the error that generated this exception.
getName() - Method in class crystalpalace.spec.LinkSpec: Return the name of the technique/tradecraft.
getStack() - Method in exception crystalpalace.spec.SpecProgramException: Get the stack from the .spec file's execution environment.
getTarget() - Method in exception crystalpalace.spec.SpecProgramException: Get the target that was executing within the .specification file (e.g., x86, x64).
getVariables() - Method in exception crystalpalace.spec.SpecProgramException: Returns the variables set in the last command that was or running when this error occured.

H

hasCapability() - Method in class crystalpalace.spec.Capability: Check if this Capability is associated with a DLL or COFF.

I

isDll() - Method in class crystalpalace.spec.Capability: Is the capability a DLL?
isObject() - Method in class crystalpalace.spec.Capability: Is the capability a COFF?

K

key - Variable in class crystalpalace.spec.Capability: The name of the $KEY for this capability in our environment

L

label - Variable in class crystalpalace.spec.Capability: the capability-specific program label (e.g., x64.o)
LinkSpec - Class in crystalpalace.spec: An object that parses and interprets a Crystal Palace specification file.
LinkSpec(SpecParser, String) - Constructor for class crystalpalace.spec.LinkSpec: The constructor for our LinkSpec.
logSpecMessage(SpecMessage) - Method in interface crystalpalace.spec.SpecLogger: Act on output from Crystal Palace

M

message - Variable in exception crystalpalace.spec.SpecProgramException: The message associated with the error.

N

name - Variable in class crystalpalace.spec.LinkSpec: the short name of the technique/tradecraft in this .spec file
None(String) - Static method in class crystalpalace.spec.Capability: Create a Capability object, usable with the LinkSpec API, but not associated with a DLL or Object.

P

parent - Variable in class crystalpalace.spec.LinkSpec: the file associated with this spec.
parent - Variable in exception crystalpalace.spec.SpecParseException: The .spec file where these errors came from
Parse(byte[]) - Static method in class crystalpalace.spec.Capability: Create a new Capability by guessing if the capability content is a DLL or Object.
Parse(String) - Static method in class crystalpalace.spec.LinkSpec: Parse a .spec file and return a ready-to-run LinkSpec object.
Parse(String, String) - Static method in class crystalpalace.spec.LinkSpec: Parse a .spec file and return a ready-to-run LinkSpec object.
ParseDll(byte[]) - Static method in class crystalpalace.spec.Capability: Create a new Capability from a DLL
ParseObject(byte[]) - Static method in class crystalpalace.spec.Capability: Create a new Capability from a COFF Object
program - Variable in class crystalpalace.spec.LinkSpec: the execution environment for applying this specification to passed in variables
program - Variable in exception crystalpalace.spec.SpecProgramException: The program where the error occurred.

R

removeLogger(SpecLogger) - Method in class crystalpalace.spec.LinkSpec: remove a registered logger
run(byte[], Map) - Method in class crystalpalace.spec.LinkSpec: Deprecated.
as of release 12.01.25. Use Capability.Parse(byte[]) and LinkSpec.run(Capability, Map)
run(Capability, Map) - Method in class crystalpalace.spec.LinkSpec: Apply this specification file's directives to the passed in parameters.
runConfig(Capability, Map) - Method in class crystalpalace.spec.LinkSpec: Apply this specification file's directives to the passed in vars to set variables.
runDll(byte[], Map) - Method in class crystalpalace.spec.LinkSpec: Deprecated.
as of release 12.01.25. Use Capability.ParseDll(byte[]) and LinkSpec.run(Capability, Map)
runObject(byte[], Map) - Method in class crystalpalace.spec.LinkSpec: Deprecated.
as of release 12.01.25. Use Capability.ParseObject(byte[]) and LinkSpec.run(Capability, Map)

S

SpecLogger - Interface in crystalpalace.spec: An interface to receive output from Crystal Palace.
SpecParseException - Exception in crystalpalace.spec: Something went wrong while parsing a .spec file.
SpecParseException(SpecParser, String) - Constructor for exception crystalpalace.spec.SpecParseException: Construct a new SpecParseException
SpecProgramException - Exception in crystalpalace.spec: Something went wrong while applying a specification file to some values
SpecProgramException(SpecProgram, String) - Constructor for exception crystalpalace.spec.SpecProgramException: Construct a new program exception.

T

targets(String) - Method in class crystalpalace.spec.LinkSpec: Check if this specification has this specific target.
toString() - Method in class crystalpalace.spec.Capability: Get the string representation of our capability
toString() - Method in exception crystalpalace.spec.SpecParseException: Convert this exception to a human readable string.
toString() - Method in exception crystalpalace.spec.SpecProgramException: Generate a sane string representation of this error and the context where it occurred.

A B C D E G H I K L M N P R S T
All Classes All Packages