com.atlassian.confluence.importexport.impl

Class StorageFormatUserRewriter

java.lang.Object

com.atlassian.confluence.importexport.impl.StorageFormatUserRewriter

public class StorageFormatUserRewriter
extends Object

Provides facilities for extracting and rewriting storage format content that contains UserKeys as components of UserResourceIdentifiers. This is required when importing content containing UserKeys from one Confluence installation into another, where the user keys may be different.

Since:

5.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StorageFormatUserRewriter.RewriteResult Represents the results of the content rewrite operation.

Constructor Summary

Constructors

Constructor and Description
StorageFormatUserRewriter(XmlEventReaderFactory xmlEventReaderFactory, XmlOutputFactory xmlOutputFactory, Unmarshaller<UserResourceIdentifier> userResourceIdentifierUnmarshaller, Marshaller<UserResourceIdentifier> userResourceIdentifierMarshaller)

Method Summary

Modifier and Type	Method and Description
StorageFormatUserRewriter.RewriteResult	rewriteUserKeysInContent(String importedStorageFormat, com.google.common.base.Function<com.atlassian.sal.api.user.UserKey,com.atlassian.sal.api.user.UserKey> userKeyTranslator, ConversionContext conversionContext) Deprecated. since 7.0.1. Use transformUserKeysInContent(String, Function, ConversionContext)
StorageFormatUserRewriter.RewriteResult	transformUserKeysInContent(String importedStorageFormat, Function<com.atlassian.sal.api.user.UserKey,com.atlassian.sal.api.user.UserKey> userKeyTranslator, ConversionContext conversionContext) Rewrites any UserKeys in UserResourceIdentifiers in the supplied storage format content, by using the supplied function to map on userkey to another.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageFormatUserRewriter

public StorageFormatUserRewriter(XmlEventReaderFactory xmlEventReaderFactory,
                                 XmlOutputFactory xmlOutputFactory,
                                 Unmarshaller<UserResourceIdentifier> userResourceIdentifierUnmarshaller,
                                 Marshaller<UserResourceIdentifier> userResourceIdentifierMarshaller)

Method Detail

rewriteUserKeysInContent

@Deprecated
public StorageFormatUserRewriter.RewriteResult rewriteUserKeysInContent(String importedStorageFormat,
                                                                                    com.google.common.base.Function<com.atlassian.sal.api.user.UserKey,com.atlassian.sal.api.user.UserKey> userKeyTranslator,
                                                                                    ConversionContext conversionContext)
                                                                             throws XMLStreamException,
                                                                                    XhtmlException,
                                                                                    IOException

Deprecated. since 7.0.1. Use transformUserKeysInContent(String, Function, ConversionContext)

Rewrites any UserKeys in UserResourceIdentifiers in the supplied storage format content, by using the supplied function to map on userkey to another. If a given userkey cannot be translated, the original userkey will be written unmodified.

Parameters:

userKeyTranslator - The function that translates one userkey to another

Returns:

A Map of the userkey translations used for this content. Untranslated userkeys will be represented as null values.

Throws:

XMLStreamException

XhtmlException

IOException

transformUserKeysInContent

public StorageFormatUserRewriter.RewriteResult transformUserKeysInContent(String importedStorageFormat,
                                                                          Function<com.atlassian.sal.api.user.UserKey,com.atlassian.sal.api.user.UserKey> userKeyTranslator,
                                                                          ConversionContext conversionContext)
                                                                   throws XMLStreamException,
                                                                          XhtmlException,
                                                                          IOException

Rewrites any UserKeys in UserResourceIdentifiers in the supplied storage format content, by using the supplied function to map on userkey to another. If a given userkey cannot be translated, the original userkey will be written unmodified.

Parameters:

userKeyTranslator - The function that translates one userkey to another

Returns:

A Map of the userkey translations used for this content. Untranslated userkeys will be represented as null values.

Throws:

XMLStreamException

XhtmlException

IOException

Since:

7.0.1