All Classes and Interfaces
Class
Description
An abstract data handler which works with
IRepositoryServiceAbstract implementation of an enum factory.
Implementations are required to extend
AbstractExportCommand.Abstract implementation of
IExternalRepositoryConfiguration that should be used
as base for configuration beans of particular repository providers.Abstract
IJobDescriptor.IJobParameter.Abstract base for
IJobUnits.Extend this class to implement your custom
ITestsFileProcessor,
it will allow your implementation to work even when new methods are added to the ITestsFileProcessorThis is an abstract implementation of list which wraps underlying list into a
typed PObject level.
Raised when access is denied to some resource.
Authenticator type to use with personal access token
Administration permission class.
Announcement implementation with the setter methods.
Simple array
IJobDescriptor.IJobParameter.Thrown by the
ILogin.IFinal.perform()
method, if the given credentials are not correct.Enumeration of permissions supported by the authentication source.
The base implementation of the template factory that returns the default implementation
of the export template and no default template.
IJobDescriptor implementation which is not hidden and presents only one (root) group.Methods for proper deployment to
IBuildInformationRepository (BIR).Information about deployment artifact deployed to
IBuildInformationRepository.IJobDescriptor.IJobParameter implementation which holds values of type IBuildArtifact.Matching selectors and artifacts.
IBuildArtifactSelector implementation.Helper methods for build (and calculation) properties manipulation.
IBuildsPolicy implementation.Use this repository decorator in batch operations
Like new CachedFactBaseRepository(repository) , than the batch operation would load the factbase just ones
Change password permission class.
HiveMind configuration class for
IBuildExtender.Thrown, when the configuration is determined to be invalid (inconsistent) or
missing.
Sole implementation of
IContextId.Enumeration class to represent possible context nature values.
Helper for type conversions.
This is an implementation which wraps lists appearing in the custom fields.
Implementation of
IObjectResolver.Extend this class if you just want to do some processing after another processor does it's work.
A generic two-way or three-way differencing engine.
The data handler which returns the DOM as result of reading configuration
Base of .status file creator in the form of job listener.
Policy class is
IBuildsPolicy.Deprecated.
Immutable empty typed collection.
Sole implementation of
IEncapsulatedObjectId.Implementation of
IExportConfiguration suitable for simple exports and for subclassing.An abstract adapter class for receiving change revision events
(and other events of file(folder) changing.
Annotation is used to determine
usernames, passwords, and access tokens in the configuration beans of external repositories, and groups
them into credential pairs (username and password or username and token).
An abstract adapter class for receiving file(folder) change events.
Contribution class for registering the form extension.
Deprecated.
Deprecated.
Generic builder-related exception.
Generic jobs-related exception.
Simple and easy-to-reuse implementation of
IJobUnitFactory.Generic
IPermissionFactory.Object encapsulation of the group-roles.xml configuration file.
IJobDescriptor implementation intended for hidden jobs
(not shown to the user in scheduler UI and similar places).Options defining which types of hyperlinks will be removed from the exported PDF file.
Provider of ACL configurations (in the form of parsed DOMs).
Configuration listener.
Signatures settings for a workflow action.
An interface for an adaptable object.
An adapter factory defines behavioral extensions for one or more classes that
implements the
IAdaptable interface.Announcement (message) interface.
Handles the delivery of the announcement.
Typed interface for the work item approval structure.
Encapsulation of the condition/function/validator arguments, as defined in
the workflow definition file.
WARNING: For internal use only.
Represents the result status of the password verification.
Extension of
PersistencePolicy to include authentication source permission checking.Common marker interfacse for configuration listeners.
Baselines represent a state (represented by a base revision) in the history of an object (a base object)
from the Project that contains the Baseline.
Functionality related to baselines.
A branch configuration for a Document.
Branches one or more Documents.
Build representation.
Build artifact.
IBuildArtifact engineer.Components and methods necessary for all engineering work.
IBuildArtifactEngineer repository.Build artifact recognizer.
Recognized build artifact.
Repository of
IBuildArtifactRecognizers.IBuildArtifact selector.Information about deployment artifact deployed to
IBuildInformationRepository.Build descriptor.
Build definition.
Build dependency definition (rebuild policy definition).
Base interface of build deployment definitions.
Derived build deployment.
Simple build deployment.
Builder service.
Build event.
List of build events.
Build extender.
Extender execution context.
Repository of
IBuildExtenders.Build extension hook "enumeration".
Build information repository.
Builds policy class.
Build status.
Build status type "enumeration".
Build test results.
Calculation descriptor.
Report definition.
Handles the context data used for workflow functions, conditions and
validators.
Object representation of an atomic change of
IPObject,
or we can say of status of the object plus changes leading to this status.Typed
IJobUnit.This job will remove work dirs of other jobs which were last modified before given time.
Interface for types to use code mirror
Typed interface for the work item comment
IPObject.Comment sorting type.
Contains the result of two project baselines comparison.
Deprecated.
Value holder for the returned configurations.
Catches problems which occur during processing of configuration files stored in repository.
Problem.
Problem severity.
Deprecated.
Enumeration that is based on a configuration in repository.
Factory that creates configurable enumerations (
IConfigurableEnumeration).A context ID consists of a cluster name (optional) and a context name.
The interface for receiving the context change events.
Interface for contribution of Project nature recognition logic.
Used to contribute the the mapping between contexts and
model objects - if such mapping exists.
This service builds the logical structure of contexts on top of the
repository (repository service) to be used by the rest of the application.
Build artifact with contextual information.
Repository of
IContextualBuildArtifacts.This interface serves for discovery of existing workflow conditions,
functions and validators and for instantiations of these.
Calculation descriptor for custom calculations.
Calculator definition.
Custom field prototype.
Custom fields provider.
An extension of
ICustomFieldsProvider that is aware of conditionally defined custom fields.This interface holds the configuration of custom field types
Provides methods for searching and counting the persistent objects in the database.
Configuration data handler.
Context data used inside
IDataHandler methods.Data prototypes provider.
The builder helps the class prepare all options for updating the Derived Document action.
Compares field values of an
IPObject.Entry point for higher-level object diffing and history analysis.
Document workflow signature represents a signature for one transition to a workflow status of a document.
Pluggable provider of dynamic roles.
Provider of dynamic roles.
Service specific part of
SubterraURI encapsulating IObjectId.The factory service to produce context dependend
IEnumerationWarning: the
IEnumFactory.getEnumeration(String, IContextId) method of the implementing classes
must return instances of IObjectEnumeration to work correctly in all cases.This type represent on model the enumeration.
Manager of listeners interested in the persistence events.
Execute system command.
The preprocessor of export configurations.
Deprecated.
implement
IExportCommandFactory insteadManages exporters and export templates, and executes exports.
A template for export.
The factory for templates for an exporter.
Extended
IFileChangesListener.This interface represents the location of a resource inside a repository and contains information about a
specified position within the resource and its repository branch.
Extends
IRevisionMetaData
with location change information from ILocationChangeMetaData.Base interface of configuration classes used by repository providers.
Provides support for linking of revisions from one type of external repositories
(e.g.
Used by external repositories to notify the system about new revisions,
and to save their state.
Registry of external repository providers and access point for configured external repositories
and external repository configurations.
Repository suitable for Resource Traceability usage.
Wrapper class for
URI used as external work item link.Enumeration defining the types of links between work item of type variant and of type feature.
Structure defined on work item of type variant (variant type is set by property com.polarion.variants.variantType) to keep the links to
work items of type feature (defined by property com.polarion.variants.featureType) and their relation to the variant: included, excluded or
implicitly included.
Structure used in IFeatureSelection structure.
Object representation of change in one field of IPObject.
Listener used by
IRepositoryService
clients.Interface of form extension - that means a panel which can be displayed in the form of persistent object in Polarion UI.
The object containing the contextual information that the extension should use to render the content.
Repository which can be frozen in time.
Workflow functions are automatically executed upon the action execution.
Resource Traceability repository configuration for a Git repository.
Internal API, do not use.
Common interface for
IPObject and IStructure for getting and setting values.The typed interface for work item hyperlinks.
Immutable enumeration option.
The key of the option used for an option identity.
Transactions must be handled by implementations of this interface
(i.e.
Deprecated.
implement
IImportCommandFactory insteadManages importers and import templates, and executes imports.
Builder interface providing the methods to configure and execute index searches.
Result holder for
IIndexSearch.Job.
Job (unit) descriptor.
Job parameter descriptor.
Choice.
Optional "flavor" type adding choice support to any type.
Parameter group.
List type (ordered list of items of same type).
Specialized multi-choice list.
Primitive type (single value).
Structure type (map).
Job parameter type.
Extension to
ILogEvent which allows to track which jobs
send what events.Job manager.
Multi-status (status encapsulating zero or more other statuses).
Resource used for determination of what jobs can be run simultaneously.
Job scheduler service.
Handler which is able to construct job scope (see
IJobUnit.getScope() from string.Job service.
Listener which will react on changes of
IJob.getState().Common interface for everyone willing to fire notifications for
IJobStateListener.Job status (result of job's execution).
Job status type "enumeration".
Job unit.
Factory for
IJobUnits (job implementations).Repository of
IJobUnitFactorys.Language definition.
Provider of
ILanguageDefinitions.LDAP synchronization flow builder.
An extension interface to add builder pattern methods to
ILdapSynchronizationSecond step of configuring a flow.
Base interface for synchronizing users from LDAP server.
An extension interface to add builder pattern methods to
ILdapUserGroupSynchronizationNew API for synchronizing users from LDAP server.
An extension interface to add builder pattern methods to
ILdapUsersSynchronizationThe typed interface for the OSLC item link structure.
The typed interface for the revision link structure.
The typed interface for the work item link structure.
Rule defining from which and to which Work Item types the role can be used.
This is UNORDERED list represented by java.util.Collection.
Local deployment definition.
Local (in-context) object identification (local id).
Simple structured repository which can be synchronized locally.
This is a common interface for objects, which are bound to particular
repository location.
This interface represents location of some resource inside some
repository.
Meta data for location change.
Recorded log event.
Log event severity "enumeration".
This is the main Logging interface that any logging subsystem should implement.
Logging subsystem interface.
Configures login flow.
Configures login flow to use some specific flow for authentication.
Login policy class.
This job will remove log files which are too old.
Typed
IJobUnit.Report of moveIn and moveOut methods - which work items were skipped
and which additional were moved.
Mutable extension of
IModulePageLayouter.IRenderingLayout.Builder of the module (document) home page content.
The term "module" in older methods has been replaced with "Document" in
both the UI and any new methods that are added.
Module home page layouter.
Layout definition.
Creates a query for Document Work Items.
This job will execute multiple jobs at once (sequentially or in parallel).
Can be thrown when invoking methods on an inaccessible job.
The notification creators are reused, therefore they should be stateless,
It's guaranteed, that they will be called only from one thread, so they don't
have to be thread-safe.
The basic data related to the notification event.
The renderer of notification events, contributed per event-id
into the
NotificationEventHandler via the configuration point
com.polarion.psvn.core.notifications.renderers.Thrown in case that user tries to set invalid value to some field in
persistence-managed object.
Parent-child hierarchy provider.
Object identification (object id).
Support for conversions between various
object identifications and representations.
Access point for the interfaces used to search and count persistent objects in various secondary data sources.
The exported page format (A4, A3, letter,...).
Manager of parameters and parameter definitions of the parent object.
Manager of parameters of the parent object.
Configures login flow to use user name and password for authentication.
The permission interface.
IPermission factory.The persistence event groups the information on objects,
which were changed together (i.e.
It is guaranteed, that in each moment of time, only one thread will
call methods on this interface.
Persistence policy class.
Now contains only the work item, but in future there might be other fields.
This class provides simple access to plan a basic statistics.
Services which need to know the platform should implement this interface.
This is the super class of all the persistent objects.
Represent the diff between two pobjects
The collection that holds
IPObjects.The preprocessor for PObject export configurations.
Allows
IBuildArtifactEngineer.amendBuildArtifact(IEngineeringContext)
to populate build artifact with some values.Typed interface for work item priorities.
Leveraged directly from Eclipse:
The
IProgressMonitor interface is implemented
by objects that monitor the progress of an activity; the methods
in this interface are invoked by code that performs the activity.IPObject representation of the project.IPObject representation of project group.Manages the life cycle of projects.
IJobUnit which allows to create, delete, unmark, move and mark projects.The root service to manage projects.
The template properties are specified in
template.properties
file in the template directory root.Query expanders are contributable componentes that are given the possibility
to pre-process queries passed to the data service.
A helper class for query manipulation.
Read operations for simple structured file repository.
Reference list is UNORDERED list represented by java.util.Collection.
Relation mapping between two lists of values
This interface is not intended to be implemented by clients.
Reports repository.
Registered report.
Loads the configurations the repository.
Connection to some hierarchical file storage.
Represent the repository registry record
Connection to hierarchical file storage.
Stores arbitrary files in a hierarchical (folders-files)
structure.
System properties of given resource.
RT repository configuration that is used to open connections to remote external repositories.
Meta data for one resource revision.
Interface for selecting the rich page using optional project id and revision and mandatory page path or space id and page name.
Each instance can be used only once.
Security referee.
The entry point for authentication and authorization tasks.
Shutdown service.
Signature of a user.
Signature related data of a comment.
Signature policy determines the overall signature state from a list of signatures.
Overall signature state of a workflow signature.
Verdict of a signature.
Calculation descriptor for site reports.
Source files repository.
Creator of
ISourceRepository implementations.Interface for selecting the space using optional project id and space id.
Structured log message for
ILogger.Resource Traceability repository configuration for an SVN repository.
This job will synchronize Polarion users, belonging to specific User Groups, with LDAP based on the LDAP search filter set up in the respective User Groups.
This job will synchronize Polarion users with LDAP based on the LDAP search filter set up in Polarion administration.
Repository which has some notion of tags.
Deprecated.
instead of implementing this interface, provide
IExportTemplateFactory in the exporter contribution (since 3.17.1)Test case specific view of a work item.
Interface of processor of tests results files, for example xUnit xml files.
Source for the processor.
Configures login flow to use some token for authentication.
Tracker policy.
This is the tracker-aware extension of the revision interface.
The main entry point for tracker-related functionalities.
Loaded externally linked work item.
Tracker-aware extension of
IUser class.List, which wraps underlying collection in from the IDataObject to the level
of the
IPObjects.This is a common interface for objects, which are bound to particular
project.
The model representation of user.
Represents user access token
Represents user access token builder
Service to operate user access tokens
Manages user to authentication provider relations
This is a marker that given exception contains user-readable message.
IPObject representation of a User Group.Batch update for groups containing Users and Roles.
User management policy class.
Value mapping between two values
This interface is not intended to be implemented by clients.
Represents the configuration for variant management.
API covering various variant management related tasks.
Access point to voting related features.
Repository which can be watched by
IWatchableRepositoryListeners.ILocation with last modification time.Listener for
IWatchableRepository.Changed resource.
Deprecated.
Use appropriate methods on
IPersistencePolicy.Common interface for objects that contains attachments.
Workflow conditions assigned to a particular workflow action are
checked to determine, whether the action is permitted at given time.
Handles the functionality related to workflow - both the workflow transitions
(these have delegate methods on
IWorkflowObject interface, so
don't have to be called directly) and for work with the workflow
configuration.Workflow signature represents signature for one transition to a workflow status of the parent object.
A working calendar is used to define standard working and nonworking times.
Defines either regular days of the week or exception days in the calendar.
Defines the time worked on the working day.
The typed interface for Work Items.
Note that this class would deserve a better name, since the current one is confusing
(it's not managing the link roles, it's managing restrictions on which types
can reference which types with which role.
Sole implementation of this interface is
WorkReportConfiguration.Write operations for simple structured repository.
Interface indicating that object can be represented as XML element.
Job execution request.
IJobDescriptor.IJobParameterPrimitiveType implementation.Job schedule.
Job state "enumeration".
Implementation of
IJobMultiStatus.ILocalDeploymentDefinition implementation.Sole implementation of
ILocalId.Prototype resolver used in
LocalId.getLocalIdFromPrototypeLessString(String, IPrototypeResolver).Parameters with
null value are rendered as empty string.Sole implementation of
ILocation.IJobDescriptor.IJobParameter of type ILocation.This class represents the main Logger object used to obtain
logger instances.
Login permission class.
ILoginPolicy implementation.Specify the left, right, top and bottom page margins.
This is an implementation which wraps lists appearing in the model and thus
can produce typed content.
Multi-job execution request.
NavigationExtender represents the main topic in the navigation panel.
Selector of a cluster node(s).
Thrown by
IPrototypeService on an
attempt to translate invalid name prototype into a prototype instance.Exception indicating that called operation needs connection.
Polarion global notification settings (smtp host, sender email address, subject prefix)
Does nothing, to be used when no progress monitor is passed to client code.
Configures login flow to use OAuth2 token for authentication.
Enables the possibility to set up a custom filename for the result of a PDF export.
Names of these object types are used as tags in the XML configuration for PDF export.
Page formats.
Specify the page header or footer.
Options for an exporter specifying page format, headers etc.
A page's orientation.
The scope of pages in a document.
Specify a watermark for an exporter.
Configures login flow to use user name and password for authentication.
Representing
IJobDescriptor.IJobParameter of type Path.This is the basic
IPermission implementation.Thrown when checked permission is denied.
This is a parent class for all exceptions generated by Persistence.
The platform context.
The base implementation of
IPObject interface.Object exporter configuration.
Helper methods for working with POM files.
Data handler that reads/writes the
Properties to/from a configuration.IJobDescriptor.IJobParameter implementation which holds values of type Properties.This class lists all public JavaScript functions that can be used on Live Report pages,
Plans, Test Runs, Documents and Classic Wiki pages.
Thrown on an attept to modify read only
IPObject or it's field.Generic implementation of an enum factory.
Report permission class.
ConfigurationException for configurations stored in repository.Root of uniform Repository exception hierarchy.
Exception raised when there was a conflict while resource was
modified.
Raised when resource was not found.
The branch collection configuration fetched from the Polarion side.
Contains all the information and methods needed for the repository file's collection processing.
The factory for creating collection model entities.
Builder for
RtFileProperties.The collector of changed files from the repository.
The element object that represents various declarations in the source file depending on the target parser language.
The builder for creating elements
RtElement.A representation of an actual repository file including its properties and content.
Repository file's properties.
The link object that references Polarion objects like Work Items from the source file.
The builder for creating link objects
RtLink.A link reference to a Polarion object.
The possible Polarion object types that are used in
RtObjectReference.The Parser for the source files collected from the repository.
Implement this interface to add additional information related to the parser.
The parser configuration properties.
The context used while parsing.
The wrapper for the exception that could not be handled by the parser implementation.
The factory for creating parsing model entities.
The repository collection configuration fetched from the Polarion side.
Runnable which permits the execution of a set of operations that can throw exceptions and/or return a result.Configures login flow to use SAML token for authentication.
Remote client for com.polarion.platform.shutdown.IShutdownService.
Simple
IJobDescriptor.IJobParameter.Size in default units depending on a particular export and the place of usage.
Deprecated.
This implementation is not thread safe.
Subterra URI:
subterra:_service_locator_:_service_specific_part_.Configures login flow to use TeamCenter Security Services token for authentication.
The factory used to create a Teamcenter Security Services (TCSS) token that can
then be passed directly to the
ISecurityService.loginWithToken(String, String) method
and used for token logins.Contribution class for registering the test file processors.
A primitive text type to be used in the model objects.
This class simplifies the execution of transactions.
Analogical to ThreadLocal but works in scope of transaction - after tx ends the reference to value is cleared.
INTERNAL This class is not part of Polarion API.
Thrown by an operation on
IPObject which has a key name
as parameted and the given key does not exits.Raised when resource was not found.
Thrown when an operation needs to resolve an
IPObject
which is actually unresolvable.Configuration to store user to authentication provider relations
Implementation of
RuntimeException marked as user friendly.Object encapsulation of the user-groups.xml configuration file.
User management permission class.
IUserManagementPolicy implementation.Object encapsulation of the user-roles.xml config file
Utility classes for Polarion Web Services.
FOR INTERNAL USE ONLY!
The
message should contain meaningfull message.The
WebServiceFactory class is a factory class for getting instances of Polarion Web Services stubs.Exception to wrap nonruntime exceptions regardless of them type
System.getProperty(String)to access all configuration properties.